diff options
author | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-08 23:14:09 -0700 |
---|---|---|
committer | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-08 23:14:09 -0700 |
commit | 90b15a391b5ed69f64cd4ffbf154e3e41bb241cb (patch) | |
tree | 6b874cd0285ad9ba1f450b47d7a363689a15ed16 | |
parent | 8481b942ed90dc7b85425bbc7411ad208e88246e (diff) | |
download | xnt-90b15a391b5ed69f64cd4ffbf154e3e41bb241cb.tar.gz xnt-90b15a391b5ed69f64cd4ffbf154e3e41bb241cb.tar.xz |
Update `xntcall` documentation
-rw-r--r-- | docs/source/taskreference.rst | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/docs/source/taskreference.rst b/docs/source/taskreference.rst index 1c5fbe8..d55f387 100644 --- a/docs/source/taskreference.rst +++ b/docs/source/taskreference.rst @@ -89,22 +89,17 @@ Miscellaneous Tasks *stdout* and *stderr* must be an open file handle. [However, that may change; I'm not sure how I feel about that yet.] -.. _xnt.tasks.xnt: -.. function:: xnt(target, path) +.. _xnt.tasks.xntcall: +.. function:: xntcall(path, targets=None, props=None) - Invoke the *target* of a build file in a different *path*. + 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 with the small difference, however, of not allowing an - empty target. + regular invocation. *path* is the relative or full path to where the "sub" *build.py* file can be found. - **Notice**: the use of this function requires fully qualified naming. - (i.e., *xnt.tasks.xnt(target, path)*). This will remain so until a better - name can be found for it. - Compile Tasks ============= |