summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkennyballou <kballou@onyx.boisestate.edu>2013-03-18 12:51:42 -0600
committerkennyballou <kballou@onyx.boisestate.edu>2013-03-18 12:51:42 -0600
commitfbdeda8b79d3c5ecd86e7a37fd09b14e8bce305b (patch)
tree7163d7b3fbf875d86e5c7dbb4fe64ed00889d3d7
parent8ce8cccae38bcd687f4adc552ae69d1f042ca574 (diff)
downloadxnt-fbdeda8b79d3c5ecd86e7a37fd09b14e8bce305b.tar.gz
xnt-fbdeda8b79d3c5ecd86e7a37fd09b14e8bce305b.tar.xz
Update make documentation: add parameter passing
-rw-r--r--docs/source/buildreference.rst15
1 files changed, 12 insertions, 3 deletions
diff --git a/docs/source/buildreference.rst b/docs/source/buildreference.rst
index 2325c7d..e277162 100644
--- a/docs/source/buildreference.rst
+++ b/docs/source/buildreference.rst
@@ -21,35 +21,44 @@ Apache Ant
----------
.. _xnt.build.make.ant:
-.. function:: ant(path="", target="", flags=None)
+.. function:: ant(path="", target="", flags=None, pkeys=None, pvalues=None)
Invoke Apache Ant in either the current working directory or the specified
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*.
+ *pkeys* and *pvalues* will be zipped together and append to the command
+ in the form: *-Dpkey=pvalue*.
+
Gnu Make
--------
.. _xnt.bulid.make.make:
-.. function:: make(path="", target="", flags=None)
+.. function:: make(path="", target="", flags=None, pkeys=None, pvalues=None)
Invoke Gnu Make (*make*) in either the current working directory or the
specified 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 *make*.
+ *pkeys* and *pvalues* will be zipped together and append to the command
+ in the form: *pkey=pvalue*.
+
(.NET)Ant
---------
.. _xnt.build.make.nant:
-.. function:: nant(path="", target="", flags=None)
+.. function:: nant(path="", target="", flags=None, pkeys=None, pvalues=None)
Invoke NAnt in either the current working directory or the specified
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*.
+ *pkeys* and *pvalues* will be zipped together and append to the command
+ in the form: *-D:pkey=pvalue*.
+
Compiler Collection
===================