diff options
| author | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-10 20:54:19 -0600 |
|---|---|---|
| committer | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-10 20:54:19 -0600 |
| commit | ba393af1d25e4a83ea02e11885f7d4c9d1fdf07f (patch) | |
| tree | 255c52fcfd74c848c744678e80e049ac8d9a5eff /docs | |
| parent | 53069d8212a5e87802ca9535191e8cb056d9a787 (diff) | |
| parent | 4edf99b3064e9eb29e8d48e6f4954a71a8a98425 (diff) | |
| download | xnt-ba393af1d25e4a83ea02e11885f7d4c9d1fdf07f.tar.gz xnt-ba393af1d25e4a83ea02e11885f7d4c9d1fdf07f.tar.xz | |
Merge branch: parser re-write
Conflicts:
xnt/commands/target.py
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/taskreference.rst | 5 | ||||
| -rw-r--r-- | docs/source/xenant.rst | 23 |
2 files changed, 15 insertions, 13 deletions
diff --git a/docs/source/taskreference.rst b/docs/source/taskreference.rst index a65f00e..3a36d21 100644 --- a/docs/source/taskreference.rst +++ b/docs/source/taskreference.rst @@ -89,15 +89,14 @@ Miscellaneous Tasks change; I'm not sure how I feel about that yet.] .. _xnt.tasks.xntcall: -.. function:: xntcall(path, targets=None, props=None) +.. function:: xntcall(buildfile, targets=None, props=None) Invoke the *target(s)* of a build file in a different *path*. *target* is the name of the target to invoke (similar to *target* of a regular invocation. - *path* is the relative or full path to where the "sub" *build.py* file can - be found. + *buildfile* is the path (relative or full) and build file to use Compile Tasks ============= diff --git a/docs/source/xenant.rst b/docs/source/xenant.rst index e9456fa..f5907bb 100644 --- a/docs/source/xenant.rst +++ b/docs/source/xenant.rst @@ -47,27 +47,27 @@ Xnt has a number of other commands that can be invoked besides those defined in the current directory's `build.py` file. One will need a build file to run. The others, however, do not. -* ``help`` prints a summary message, including information about the version of - Xnt, license, and usage. +* ``-h`` or ``--help`` prints a summary message, including information about + the version of Xnt, license, and usage. Usage:: - $ xnt help + $ xnt --help -* ``list-targets`` does exactly what the name should suggest: it prints a list - of the targets found in the current directory's `build.py` script, along with - any docstrings that may be defined with them. +* ``-l`` or ``--list-targets`` does exactly what the name should suggest: it + prints a list of the targets found in the current directory's `build.py` + script, along with any docstrings that may be defined with them. Usage:: - $ xnt list-targets + $ xnt --list-targets -* ``version`` prints Xnt's installed version. +* ``--version`` prints Xnt's installed version. Usage:: - $ xnt version + $ xnt --version .. _xntOptions: @@ -82,7 +82,10 @@ Usage:: Where options can be any and all of the following (unless otherwise specified): -* ``-v``: add verbose output to the execution of Xnt +* ``-v`` or ``--verbose``: add verbose output to the execution of Xnt + +* ``-b BUILDFILE`` or ``--build-file BUILDFILE``: specifiy to Xnt the build + module to load .. _xntPropertiesParameters: |