summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkennyballou <kballou@onyx.boisestate.edu>2013-03-09 20:28:43 -0700
committerkennyballou <kballou@onyx.boisestate.edu>2013-03-09 20:28:43 -0700
commitbef742210b3f620b6e805a77a5320b79ab78b985 (patch)
tree38ca1516dd5485227e4d8b1cd36a06e2e3a150a0
parent793bdd9d0fd2403e665ea2e117fb72096cec091b (diff)
downloadxnt-bef742210b3f620b6e805a77a5320b79ab78b985.tar.gz
xnt-bef742210b3f620b6e805a77a5320b79ab78b985.tar.xz
Update documentation about build files
-rw-r--r--README.rst3
-rw-r--r--docs/source/taskreference.rst5
-rw-r--r--docs/source/xenant.rst3
3 files changed, 8 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index a9b66f2..f501df3 100644
--- a/README.rst
+++ b/README.rst
@@ -226,6 +226,9 @@ Where ``[options]`` are one of the following:
* ``-v``: verbose, turn on logging
+* ``-b BUILDFILE`` or ``--build-file BUILDFILE``: Specify build file
+ for Xnt to load
+
And where ``[target]+`` are any target(s) method in your ``build.py``
file or:
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 156883f..f5907bb 100644
--- a/docs/source/xenant.rst
+++ b/docs/source/xenant.rst
@@ -84,6 +84,9 @@ Where options can be any and all of the following (unless otherwise specified):
* ``-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:
Properties and Parameter Passing