diff options
author | kennyballou <kballou@onyx.boisestate.edu> | 2012-12-03 18:48:34 -0700 |
---|---|---|
committer | kballou <kballou@onyx.boisestate.edu> | 2012-12-03 18:48:34 -0700 |
commit | 013572729619863cc210bbd1ffc8fc606ebc3af0 (patch) | |
tree | b8b7dcd7e4f14a0eed29eb1380bb163ca0014dd5 /docs | |
parent | 8645a0f8e3f2d5acabfd5bf4d517b1c5b289921f (diff) | |
download | xnt-013572729619863cc210bbd1ffc8fc606ebc3af0.tar.gz xnt-013572729619863cc210bbd1ffc8fc606ebc3af0.tar.xz |
Add links for cross-referencing
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/taskreference.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/source/taskreference.rst b/docs/source/taskreference.rst index 9db98f6..7ef9fd0 100644 --- a/docs/source/taskreference.rst +++ b/docs/source/taskreference.rst @@ -20,20 +20,24 @@ Overview of Tasks File Tasks ========== +.. _xnt.tasks.expandpath: .. function:: expandpath(path) Return a generator for glob expansion of *path* +.. _xnt.tasks.cp: .. function:: cp(src,dst) Copy the source file or directory (*src*) to destination file or directory (*dst*) +.. _xnt.tasks.mv: .. function:: mv(src,dst) Move the source file or directory (*src*) to destination file or directory (*dst*) +.. _xnt.tasks.mkdir: .. function:: mkdir(dir,mode=0o777) Create a directory specified by *dir* with default mode (where supported) @@ -42,6 +46,7 @@ File Tasks Notice, if the directory already exists, *mkdir* will not attempt to creat it again (or change the mode) +.. _xnt.tasks.rm: .. function:: rm(*fileset) Attempt to remove all the directories given in fileset. Before *rm* tries @@ -51,6 +56,7 @@ File Tasks Archive Tasks ============= +.. _xnt.tasks.zip: .. function:: zip(dir,zipfilename) Zip the specified directory (*dir*) into the zip file specified by @@ -59,17 +65,20 @@ Archive Tasks Miscellaneous Tasks =================== +.. _xnt.tasks.echo: .. function:: echo(msg, tofile) Write the given message to a file *echo* will handle opening and closing the file +.. _xnt.tasks.log: .. function:: log(msg="", lvl=logging.INFO) Write the message (*msg*) to the *xnt.tasks* logger using either the default log level (*INFO*) or any other valid specified value +.. _xnt.tasks.call: .. function:: call(command, stdout=None, stderr=None) Invoke the command specified, redirecting standard output and standard @@ -80,6 +89,7 @@ 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) Invoke the *target* of a build file in a different *path*. @@ -98,6 +108,7 @@ Miscellaneous Tasks Compile Tasks ============= +.. _xnt.tasks.setup: .. function:: setup(commands, dir="") Invoke Python setup.py given the list of *commands* (or options) in the @@ -106,6 +117,7 @@ Compile Tasks Apache Ant ---------- +.. _xnt.build.ant.ant: .. function:: ant(path="", target="") Invoke Apache Ant in either the current working directory or the specified @@ -114,6 +126,7 @@ Apache Ant Gnu Make -------- +.. _xnt.bulid.make.make: .. function:: make(path="", target="") Invoke Gnu Make (*make*) in either the current working directory or the @@ -123,6 +136,7 @@ Gnu Make (.NET)Ant --------- +.. _xnt.build.nant.nant: .. function:: nant(path="", target="") Invoke NAnt in either the current working directory or the specified @@ -131,9 +145,12 @@ Gnu Make SCM Tasks ========= +.. _xnt.vcs.hg: + Mercurial Tasks --------------- +.. _xnt.vcs.hg.hgclone: .. function:: hgclone(url, dest=None, rev=None, branch=None) Clone the Mercurial repository at *url* (This can be any valid URI, Local, @@ -143,28 +160,36 @@ Mercurial Tasks *rev* and *branch* can be used to clone a specific revision or a specific branch of the repository, respectively. +.. _xnt.vcs.hg.hgfetch: .. function:: hgfetch(path, source='default') Fetch any updates from either the default source or a specified source for the repository specified by *path* +.. _xnt.vcs.git: + Git Tasks --------- +.. _xnt.vcs.git.gitclone: .. function:: gitclone(url, dest=None, branch=None) Clone the Git repository at *url* (This can be any valid URI: Local, SSH, Git, HTTP(S)...) into either the default destination or specified directory (relative to the current working directory). +.. _xnt.vcs.git.gitpull: .. function:: gitpull(path, source="origin", branch="master") Pull any updates from either the default source and/ or specified branch into the existing Git repository located at *path*. +.. _xnt.vcs.cvs: + CVS Tasks --------- +.. _xnt.vcs.cvs.cvsco: .. function:: cvsco(module, rev="", dest="") Checkout the CVS module specified by *module*; getting the HEAD revision or @@ -172,6 +197,7 @@ CVS Tasks directory or the specified directory, *dest* (relative to the current working directory). +.. _xnt.vcs.cvs.cvsupdate: .. function:: cvsupdate(path) Update the CVS module located at *path*. |