diff options
| author | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-18 12:02:26 -0600 |
|---|---|---|
| committer | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-18 12:02:26 -0600 |
| commit | d0278ba0d04003627d5cf7fc6cc0d1e34b0466f1 (patch) | |
| tree | e6e542df58c84926efc7b71614721e978d65b606 | |
| parent | 4a8821204ab482eec3898540904e695cee627e79 (diff) | |
| download | xnt-d0278ba0d04003627d5cf7fc6cc0d1e34b0466f1.tar.gz xnt-d0278ba0d04003627d5cf7fc6cc0d1e34b0466f1.tar.xz | |
Update make documentation
Add `flags` parameter to function def and documentation
| -rw-r--r-- | docs/source/buildreference.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/source/buildreference.rst b/docs/source/buildreference.rst index 2cabe1f..2325c7d 100644 --- a/docs/source/buildreference.rst +++ b/docs/source/buildreference.rst @@ -21,29 +21,34 @@ Apache Ant ---------- .. _xnt.build.make.ant: -.. function:: ant(path="", target="") +.. function:: ant(path="", target="", flags=None) Invoke Apache Ant in either the current working directory or the specified - directory using the empty (default) target or the specified target. + directory using the empty (default) target or the specified target, passing + a list of *flags* to the invocation. Where *flags* is a list of valid + flags for *ant*. Gnu Make -------- .. _xnt.bulid.make.make: -.. function:: make(path="", target="") +.. function:: make(path="", target="", flags=None) Invoke Gnu Make (*make*) in either the current working directory or the specified directory using the empty (default) target or the specified - target. + target, passing a list of *flags* to the invocation. Where *flags* is a + list of valid flags for *make*. (.NET)Ant --------- .. _xnt.build.make.nant: -.. function:: nant(path="", target="") +.. function:: nant(path="", target="", flags=None) Invoke NAnt in either the current working directory or the specified - directory using the empty (default) target or the specified target. + directory using the empty (default) target or the specified target, passing + a list of *flags* to the invocation. Where *flags* is a list of valid flags + for *nant*. Compiler Collection =================== |