Mercurial > bitten > bitten-test
diff doc/recipes.txt @ 611:294641e84e89
0.6dev: Adding `${name}` and `${basedir}` (#325) for recipe substitution. Updated docs + new test.
| author | osimons |
|---|---|
| date | Sat, 01 Aug 2009 01:56:14 +0000 |
| parents | b76e6accad72 |
| children | 7a8ddf54f012 |
line wrap: on
line diff
--- a/doc/recipes.txt +++ b/doc/recipes.txt @@ -36,9 +36,9 @@ these elements are declared in XML namespaces, where the namespace URI defines a collection of related commands. -A ``<step>```element can additionally have a ``onerror`` attribute with possible -values of ``fail`` (terminate after step, default behaviour), or ``continue`` -(fail, but run next step), or ``ignore`` (errors are unimportant, continue). +A ``<step>`` element can additionally have an ``onerror`` attribute with +value of ``fail`` (terminate after step, default behaviour) or ``ignore`` +(fail, but run next step). Commonly, the first step of any build recipe will perform the checkout from the repository. @@ -75,7 +75,7 @@ `Slave Configuration`_ further custom properties can be used. Bitten supports these pre-defined properties: -.. _`slave configuration`: slaveconfig.html +.. _`slave configuration`: configure.html +-----------------+----------------------------------------------------------+ | Constant | Value | @@ -88,6 +88,13 @@ +-----------------+----------------------------------------------------------+ | ``${revision}`` | The repository revision being tested | +-----------------+----------------------------------------------------------+ +| ``${platform}`` | The name of the target platform being built | ++-----------------+----------------------------------------------------------+ +| ``${name}`` | The name of the build slave | ++-----------------+----------------------------------------------------------+ +| ``${basedir}`` | The absolute path of the build location, joining | +| | ``work-dir`` (absolute) with ``build-dir`` (relative) | ++-----------------+----------------------------------------------------------+ As the recipe needs to be valid XML, any reserved characters in attributes must be quoted using regular XML entities: