diff options
author | kennyballou <kballou@onyx.boisestate.edu> | 2012-11-07 22:40:03 -0700 |
---|---|---|
committer | kballou <kballou@onyx.boisestate.edu> | 2012-11-07 22:40:03 -0700 |
commit | ff8a6faef967c5dedab096fe71a245ef03098550 (patch) | |
tree | 3b6451d288741560764bf3923f2304a12eeb4708 /docs/source/taskreference.rst | |
parent | e07eaa57f01702315d66566b2f4c011461c666d1 (diff) | |
download | xnt-ff8a6faef967c5dedab096fe71a245ef03098550.tar.gz xnt-ff8a6faef967c5dedab096fe71a245ef03098550.tar.xz |
Add documentation for new ``xnt`` task
Diffstat (limited to 'docs/source/taskreference.rst')
-rw-r--r-- | docs/source/taskreference.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/source/taskreference.rst b/docs/source/taskreference.rst index 5d8d875..9db98f6 100644 --- a/docs/source/taskreference.rst +++ b/docs/source/taskreference.rst @@ -80,6 +80,21 @@ 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.] +.. function:: xnt(target, path) + + Invoke the *target* 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. + + *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 ============= |