diff doc/commands.txt @ 599:b76e6accad72

0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code.
author osimons
date Thu, 30 Jul 2009 09:47:48 +0000
parents 4c3d43adaa48
children f3bb52da9e3c
line wrap: on
line diff
--- a/doc/commands.txt
+++ b/doc/commands.txt
@@ -5,11 +5,13 @@
 =====================
 
 `Build recipes`_ are represented by XML documents. This page describes what
-commands are generally available in recipes. Please note, though, that
+commands are generally available in recipes, and any `runtime configuration`_
+supported by these commands. Please note, though, that
 third-party packages can add additional commands, which would then be
 documented by that third party.
 
 .. _`build recipes`: recipes.html
+.. _`runtime configuration`: configure.html
 
 .. contents:: Contents
    :depth: 2
@@ -213,6 +215,15 @@
 
   ./configure --enable-threadsafe CFLAGS="-O"
 
+Configuration
+-------------
+
+Parameter ``with`` will expand any package found in slave configuration:
+
+.. code-block:: ini
+
+  [mylib]
+  path = /path/to/mylib
 
 ------------
 ``<c:gcov>``
@@ -269,7 +280,6 @@
 |                | ``"parameter1=value1 parameter2=value2"``.                |
 +----------------+-----------------------------------------------------------+
 
-
 Examples
 --------
 
@@ -287,6 +297,14 @@
 Same as previous but execute the command in the ``work`` directory and call
 the makefile with the command line argument ``coverage=1``.
 
+Configuration
+-------------
+
+.. code-block:: ini
+
+  [make]
+  path = /path/to/(c|n)make
+
 ---------------
 ``<c:cppunit>``
 ---------------
@@ -363,6 +381,17 @@
 Executes the target ``compile`` of the ``build.xml`` buildfile at the top of the
 project source directory.
 
+Configuration
+-------------
+
+.. code-block:: ini
+
+  [ant]
+  home = /path/to/ant/dir
+  
+  [java]
+  home = /path/to/java/dir
+
 
 --------------------
 ``<java:cobertura>``
@@ -616,6 +645,14 @@
 Executes Pylint_ on the module/package ``myproj`` and stores the output into a
 file named ``pylint-report.txt``.
 
+Configuration
+-------------
+
+.. code-block:: ini
+
+  [python]
+  path = /path/to/python
+
 
 ----------------------
 ``<python:distutils>``
@@ -657,6 +694,14 @@
 Bitten), and passes the options needed to determine the output paths for test
 results and code coverage reports.
 
+Configuration
+-------------
+
+.. code-block:: ini
+
+  [python]
+  path = /path/to/python
+
 
 ---------------------
 ``<python:unittest>``
Copyright (C) 2012-2017 Edgewall Software