doc: Don't use root-prompt in wraptool examples.

A `#` is the root-prompt, whereas `$` is the user-prompt.
pull/1723/head
Elliott Sales de Andrade 8 years ago
parent f3ad633f55
commit 4ba298613d
  1. 14
      docs/markdown/Using-wraptool.md

@ -2,13 +2,13 @@
Wraptool is a helper tool that allows you to manage your source dependencies using the WrapDB database. It gives you all things you would expect, such as installing and updating dependencies. The wrap tool works on all platforms, the only limitation is that the wrap definition works on your target platform. If you find some Wraps that don't work, please file bugs or, even better, patches.
All code examples here assume that you are running the commands in your top level source directory. Lines that start with the `#` mark are commands to type.
All code examples here assume that you are running the commands in your top level source directory. Lines that start with the `$` mark are commands to type.
## Simple querying
The simplest operation to do is to query the list of packages available. To list them all issue the following command:
# wraptool list
$ wraptool list
box2d
enet
gtest
@ -24,12 +24,12 @@ The simplest operation to do is to query the list of packages available. To list
Usually you want to search for a specific package. This can be done with the `search` command:
# wraptool search jpeg
$ wraptool search jpeg
libjpeg
To determine which versions of libjpeg are available to install, issue the `info` command:
# wraptool info libjpeg
$ wraptool info libjpeg
Available versions of libjpeg:
9a 2
@ -39,21 +39,21 @@ The first number is the upstream release version, in this case `9a`. The second
Installing dependencies is just as straightforward. First just create the `subprojects` directory at the top of your source tree and issue the install command.
# wraptool install libjpeg
$ wraptool install libjpeg
Installed libjpeg branch 9a revision 2
Now you can issue a `subproject('libjpeg')` in your `meson.build` file to use it.
To check if your projects are up to date you can issue the `status` command.
# wraptool status
$ wraptool status
Subproject status
libjpeg up to date. Branch 9a, revision 2.
zlib not up to date. Have 1.2.8 2, but 1.2.8 4 is available.
In this case `zlib` has a newer release available. Updating it is straightforward:
# wraptool.py update zlib
$ wraptool.py update zlib
Updated zlib to branch 1.2.8 revision 4
Wraptool can do other things besides these. Documentation for these can be found in the command line help, which can be accessed by `wraptool --help`.

Loading…
Cancel
Save