bitten/bitten-test: doc/commands.txt annotate

annotate doc/commands.txt @ 645:8c824b14e1c5

0.6dev: Switching `master.py` to use new `self._send_response()` and `self._send_error() methods. Simplifies code, but most importantly for errors it allows a consistent method for transmitting plain-text error messages to the slave (that the slave will now output as part of debug logging). Raising Trac HTTP* errors actually causes full rendering of an HTML error page as response, which is both inefficient as well as making it near-impossible to extract the 'hidden' message from the master.

author	osimons
date	Mon, 24 Aug 2009 12:00:43 +0000
parents	900b09af6b38
children	b00da52e942f

rev	line source
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1 .. -- mode: rst; encoding: utf-8 --
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	2
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	3 =====================
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	4 Build Recipe Commands
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	5 =====================
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	6
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	7 `Build recipes`_ are represented by XML documents. This page describes what
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	8 commands are generally available in recipes, and any `runtime configuration`_
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	9 supported by these commands. Please note, though, that
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	10 third-party packages can add additional commands, which would then be
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	11 documented by that third party.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	12
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	13 .. _`build recipes`: recipes.html
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	14 .. _`runtime configuration`: configure.html
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	15
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	16 .. contents:: Contents
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	17 :depth: 2
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	18 .. sectnum::
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	19
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	20
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	21 Generic Commands
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	22 ================
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	23
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	24 These are commands that are used without a namespace prefix.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	25
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	26
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	27 ------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	28 ``<report>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	29 ------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	30
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	31 Parse an XML file and send it to the master as a report with a given category.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	32 Use this command in conjunction with the ``<sh:pipe>`` or ``<x:transform>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	33 commands to send custom reports to the build master.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	34
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	35 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	36 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	37
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	38 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	39 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	40 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	41 \| ``category`` \| Category of the report (for example "test" or "coverage"). \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	42 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	43 \| ``file`` \| Path to the XML file containing the report data, relative \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	44 \| \| to the project directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	45 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	46
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	47 Both parameters must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	48
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	49
629 f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	50 ------------
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	51 ``<attach>``
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	52 ------------
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	53
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	54 Attach a file to the build or configuration as regular attachment. An already
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	55 existing attachment on the same resource with same base filename will be
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	56 replaced.
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	57
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	58 Note: Unless consistently building latest only, overwriting files on
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	59 config level may lead to unexpected results.
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	60
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	61 Parameters
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	62 ----------
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	63
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	64 +-----------------+----------------------------------------------------------+
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	65 \| Name \| Description \|
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	66 +=================+==========================================================+
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	67 \| ``file`` \| Path to the file to attach, relative to the project \|
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	68 \| \| directory. \|
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	69 +-----------------+----------------------------------------------------------+
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	70 \| ``resource`` \| The resource to attach the file to. Either \|
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	71 \| \| 'build' (default) or 'config'. Optional. \|
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	72 +-----------------+----------------------------------------------------------+
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	73 \| ``description`` \| Attachment description. Optional. \|
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	74 +-----------------+----------------------------------------------------------+
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	75
f3bb52da9e3c 0.6dev: Adding support for attachments to configurations and build - full web implementation that mirrors what is available in Ticket and Wiki. Also added a new generic `<attach/>` command that enables attaching files to be part of a recipe and uploaded by slaves as part of build. osimons parents: 599 diff changeset	76
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	77 Shell Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	78 ===========
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	79
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	80 A bundle of generic tools that are not specific to any programming language or
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	81 tool-chain.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	82
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	83 :Namespace: ``http://bitten.cmlenz.net/tools/sh``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	84 :Common prefix: ``sh``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	85
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	86
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	87 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	88 ``<sh:exec>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	89 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	90
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	91 Executes a program or script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	92
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	93 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	94 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	95
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	96 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	97 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	98 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	99 \| ``executable`` \| The name of the executable program. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	100 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	101 \| ``file`` \| Path to the script to execute, relative to the project \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	102 \| \| directory \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	103 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	104 \| ``output`` \| Path to the output file \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	105 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	106 \| ``args`` \| Any arguments to pass to the executable or script \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	107 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	108
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	109 Either ``executable`` or ``file`` must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	110
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	111 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	112 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	113
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	114 TODO
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	115
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	116
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	117 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	118 ``<sh:pipe>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	119 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	120
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	121 Pipes the content of a file through a program or script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	122
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	123 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	124 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	125
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	126 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	127 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	128 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	129 \| ``executable`` \| The name of the executable program. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	130 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	131 \| ``file`` \| Path to the script to execute, relative to the project \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	132 \| \| directory \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	133 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	134 \| ``input`` \| Path to the input file \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	135 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	136 \| ``output`` \| Path to the output file \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	137 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	138 \| ``args`` \| Any arguments to pass to the executable or script \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	139 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	140
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	141 Either ``executable`` or ``file`` must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	142
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	143 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	144 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	145
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	146 TODO
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	147
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	148
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	149 C/Unix Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	150 ============
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	151
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	152 These commands provide support for tools commonly used for development of C/C++
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	153 applications on Unix platforms, such as ``make``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	154
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	155 :Namespace: ``http://bitten.cmlenz.net/tools/c``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	156 :Common prefix: ``c``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	157
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	158
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	159 ------------------
478 6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	160 ``<c:autoreconf>``
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	161 ------------------
478 6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	162
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	163 Executes ths autotool autoreconf.
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	164
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	165 Parameters
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	166 ----------
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	167
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	168 :param force: consider all files obsolete
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	169 :param install: copy missing auxiliary files
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	170 :param symlink: install symbolic links instead of copies
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	171 :param warnings: report the warnings falling in CATEGORY
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	172 :prepend_include: prepend directories to search path
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	173 :include: append directories to search path
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	174
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	175
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	176 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	177 \| Name \| Description \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	178 +==============+=============================================================+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	179 \| ``force`` \| Consider all files obsolete \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	180 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	181 \| ``install`` \| Copy missing auxiliary files \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	182 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	183 \| ``symlink`` \| Install symbolic links instead of copies \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	184 +--------------+-------------------------------------------------------------+
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	185 \| ``warnings`` \| Report the warnings related to category \|
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	186 \| \| (which can actually be a comma separated list) \|
478 6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	187 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	188 \| ``prepend_include`` \| Prepend directories to search path \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	189 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	190 \| ``include`` \| Append directories to search path \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	191 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	192
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	193 Examples
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	194 --------
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	195
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	196 .. code-block:: xml
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	197
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	198 <c:autoreconf force="1" install="1" warnings="cross,syntax,error"/>
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	199
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	200 Runs the ``autoreconf`` tool in the base directory with the option: force, install
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	201 and 3 warning categories active: cross,syntax,error. This is equivalent to::
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	202
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	203 autoreconf --force --install --warnings=cross,syntax,error
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	204
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	205
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	206 -----------------
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	207 ``<c:configure>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	208 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	209
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	210 Executes a configure script as generated by Autoconf.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	211
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	212 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	213 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	214
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	215 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	216 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	217 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	218 \| ``file`` \| Name of the configure script (defaults to "configure") \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	219 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	220 \| ``enable`` \| List of features to enable, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	221 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	222 \| ``disable`` \| List of features to disable, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	223 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	224 \| ``with`` \| List of packages to include, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	225 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	226 \| ``without`` \| List of packages to exclude, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	227 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	228 \| ``cflags`` \| Value of the `CFLAGS` variable to pass to the script. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	229 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	230 \| ``cxxflags`` \| Value of the `CXXFLAGS` variable to pass to the script. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	231 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	232
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	233 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	234 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	235
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	236 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	237
432 74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	238 <c:configure enable="threadsafe" cflags="-O"/>
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	239
432 74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	240 Runs the ``configure`` script in the base directory, enable the ``threadsafe``
74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	241 feature, and passing ``-O`` as ``CFLAGS``. This is equivalent to::
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	242
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	243 ./configure --enable-threadsafe CFLAGS="-O"
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	244
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	245 Configuration
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	246 -------------
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	247
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	248 Parameter ``with`` will expand any package found in slave configuration:
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	249
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	250 .. code-block:: ini
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	251
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	252 [mylib]
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	253 path = /path/to/mylib
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	254
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	255 ------------
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	256 ``<c:gcov>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	257 ------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	258
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	259 Run gcov_ to extract coverage data where available.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	260
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	261 .. _gcov: http://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	262
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	263 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	264 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	265
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	266 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	267 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	268 +==============+============================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	269 \| ``include`` \| List of glob patterns (separated by space) that specify \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	270 \| \| which source files should be included in the coverage \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	271 \| \| report \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	272 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	273 \| ``exclude`` \| List of glob patterns (separated by space) that specify \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	274 \| \| which source files should be excluded from the coverage \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	275 \| \| report \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	276 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	277 \| ``prefix`` \| Optional prefix name that is added to object files by the \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	278 \| \| build system \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	279 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	280
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	281
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	282 ------------
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	283 ``<c:make>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	284 ------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	285
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	286 Executes a Makefile.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	287
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	288 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	289 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	290
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	291 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	292 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	293 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	294 \| ``target`` \| Name of the target to execute (defaults to "all") \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	295 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	296 \| ``file`` \| Path to the Makefile that should be used. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	297 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	298 \| ``keep-going`` \| Whether `make` should try to continue even after \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	299 \| \| encountering errors. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	300 +----------------+-----------------------------------------------------------+
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	301 \| ``jobs`` \| Number of parallel jobs used by make. \|
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	302 +----------------+-----------------------------------------------------------+
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	303 \| ``directory`` \| Path of the directory in which make should be called. \|
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	304 +----------------+-----------------------------------------------------------+
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	305 \| ``args`` \| Any space separated arguments to pass to the makefile. \|
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	306 \| \| Usually in the form: \|
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	307 \| \| ``"parameter1=value1 parameter2=value2"``. \|
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	308 +----------------+-----------------------------------------------------------+
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	309
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	310 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	311 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	312
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	313 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	314
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	315 <c:make target="compile" file="build/Makefile" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	316
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	317 Runs the target "compile" of the ``Makefile`` located in the sub-directory
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	318 ``build``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	319
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	320 .. code-block:: xml
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	321
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	322 <c:make target="compile" file="build/Makefile" directory="work" args="coverage=1" />
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	323
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	324 Same as previous but execute the command in the ``work`` directory and call
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	325 the makefile with the command line argument ``coverage=1``.
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	326
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	327 Configuration
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	328 -------------
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	329
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	330 .. code-block:: ini
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	331
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	332 [make]
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	333 path = /path/to/(c\|n)make
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	334
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	335 ---------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	336 ``<c:cppunit>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	337 ---------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	338
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	339 Report the test output generated by the CppUnit_ unit testing framework. The
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	340 output from CppUnit must be in XML format and in already, specified by the
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	341 ``file`` argument of this recipe.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	342
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	343 .. _cppunit: http://cppunit.sourceforge.net
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	344
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	345 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	346 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	347
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	348 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	349 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	350 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	351 \| ``file`` \| Path to the cppunit XML output file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	352 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	353
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	354 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	355 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	356
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	357 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	358
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	359 <sh:exec executable="run_unit_tests" output="test_results.xml" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	360 <c:cppunit file="test_results.xml" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	361
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	362 Runs the program ``run_unit_tests`` to gather the data output by CppUnit in the
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	363 ``test_results.xml`` file and then reports it.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	364
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	365
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	366 Java Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	367 ==========
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	368
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	369 A bundle of recipe commands that support tools commonly used by Java projects.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	370
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	371 :Namespace: ``http://bitten.cmlenz.net/tools/java``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	372 :Common prefix: ``java``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	373
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	374
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	375 --------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	376 ``<java:ant>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	377 --------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	378
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	379 Runs an Ant_ build.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	380
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	381 .. _ant: http://ant.apache.org/
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	382
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	383 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	384 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	385
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	386 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	387 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	388 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	389 \| ``file`` \| Path of the build file, relative to the project source \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	390 \| \| directory (default is ``build.xml``). \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	391 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	392 \| ``target`` \| Name of the build target(s) to execute. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	393 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	394 \| ``args`` \| Additional arguments to pass to Ant, separated by \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	395 \| \| whitespace. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	396 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	397 \| ``keep_going`` \| Tell Ant to continue even when errors are in encountered \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	398 \| \| in the build. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	399 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	400
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	401 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	402 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	403
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	404 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	405
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	406 <java:ant target="compile" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	407
432 74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	408 Executes the target ``compile`` of the ``build.xml`` buildfile at the top of the
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	409 project source directory.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	410
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	411 Configuration
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	412 -------------
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	413
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	414 .. code-block:: ini
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	415
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	416 [ant]
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	417 home = /path/to/ant/dir
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	418
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	419 [java]
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	420 home = /path/to/java/dir
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	421
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	422
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	423 --------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	424 ``<java:cobertura>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	425 --------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	426
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	427 Extract code coverage data from a Cobertura_ XML file.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	428
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	429 .. _cobertura: http://cobertura.sourceforge.net/
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	430
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	431 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	432 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	433
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	434 +----------------+-----------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	435 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	436 +================+===========================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	437 \| ``file`` \| Path to the XML file generated by Cobertura \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	438 +----------------+-----------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	439
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	440 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	441 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	442
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	443 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	444
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	445 <java:cobertura file="build/cobertura.xml" />
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	446
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	447 Reads the specifid XML file, extracts the coverage data, and builds a coverage
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	448 report to be sent to the build master.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	449
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	450
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	451 ----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	452 ``<java:junit>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	453 ----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	454
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	455 Extracts information about unit test results from a file in JUnit_ XML format.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	456
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	457 .. _junit: http://junit.org/index.htm
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	458
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	459 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	460 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	461
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	462 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	463 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	464 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	465 \| ``file`` \| Path to the JUnit XML test results file. This can include \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	466 \| \| wildcards, in which case all the file matching the \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	467 \| \| pattern will be included. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	468 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	469 \| ``srcdir`` \| Path of the directory unit test sources. Used to link the \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	470 \| \| test cases to files. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	471 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	472
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	473 The ``file`` attribute is required.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	474
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	475 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	476 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	477
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	478 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	479
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	480 <java:junit file="build/tests/results/TEST-*.xml" srcdir="src/tests" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	481
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	482 Collects the test results from all files in the `build/tests/results` directory
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	483 that match the pattern `TEST-*.xml`. Also, maps the class names in the results
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	484 files to Java source files in the directory `src/tests`.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	485
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	486
550 6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	487 Mono Tools
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	488 ==========
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	489
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	490 A bundle of recipe commands that support tools commonly used by Mono/.NET projects.
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	491
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	492 :Namespace: ``http://bitten.cmlenz.net/tools/mono``
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	493 :Common prefix: ``mono``
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	494
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	495 ----------------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	496 ``<mono:nunit>``
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	497 ----------------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	498
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	499 Extracts information about unit test results from a files in NUnit_ XML format.
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	500
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	501 .. _nunit: http://nunit.org/
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	502
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	503 Parameters
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	504 ----------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	505
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	506 +----------------+-----------------------------------------------------------+
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	507 \| Name \| Description \|
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	508 +================+===========================================================+
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	509 \| ``file`` \| Path to the NUnit XML test results file. This can include \|
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	510 \| \| wildcards, in which case all the file matching the \|
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	511 \| \| pattern will be included. \|
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	512 +----------------+-----------------------------------------------------------+
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	513
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	514 The ``file`` attribute is required.
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	515
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	516 Examples
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	517 --------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	518
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	519 .. code-block:: xml
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	520
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	521 <mono:nunit file="build/tests/TestResult.xml" />
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	522
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	523
416 ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	524 PHP Tools
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	525 =========
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	526
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	527 A bundle of recipe commands for PHP_ projects.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	528
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	529 :Namespace: ``http://bitten.cmlenz.net/tools/php``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	530 :Common prefix: ``php``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	531
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	532 .. _php: http://php.net/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	533
422 9d1631a751f8 Fix typo in recipe commands reference. Closes #162. cmlenz parents: 416 diff changeset	534 ---------------
9d1631a751f8 Fix typo in recipe commands reference. Closes #162. cmlenz parents: 416 diff changeset	535 ``<php:phing>``
9d1631a751f8 Fix typo in recipe commands reference. Closes #162. cmlenz parents: 416 diff changeset	536 ---------------
416 ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	537
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	538 Runs a Phing_ build.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	539
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	540 .. _phing: http://phing.info/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	541
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	542 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	543 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	544
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	545 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	546 \| Name \| Description \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	547 +===================+=======================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	548 \| ``file`` \| Path of the build file, relative to the project \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	549 \| \| source directory (default is ``build.xml``). \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	550 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	551 \| ``target`` \| Name of the build target(s) to execute. \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	552 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	553 \| ``args`` \| Additional arguments to pass to Phing, separated by \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	554 \| \| whitespace. \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	555 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	556 \| ``executable`` \| Phing executable program (default is ``phing``). \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	557 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	558
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	559
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	560 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	561 --------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	562
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	563 .. code-block:: xml
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	564
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	565 <php:phing target="compile" />
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	566
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	567 Executes the target ``compile`` of the ``build.xml`` buildfile at the top of the
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	568 project source directory.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	569
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	570
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	571 -----------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	572 ``<php:phpunit>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	573 -----------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	574
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	575 Extracts information from PHPUnit_ test results recorded in an XML file.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	576
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	577 .. _phpunit: http://www.phpunit.de/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	578
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	579 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	580 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	581
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	582 +----------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	583 \| Name \| Description \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	584 +================+===========================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	585 \| ``file`` \| Path to the XML results file, relative to the project \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	586 \| \| source directory. \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	587 +----------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	588
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	589 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	590 --------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	591
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	592 .. code-block:: xml
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	593
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	594 <php:phpunit file="build/test-results.xml"/>
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	595
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	596 Extracts the test results from the XML file located at
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	597 ``build/test-results.xml``.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	598
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	599
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	600 ------------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	601 ``<php:coverage>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	602 ------------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	603
597 4c3d43adaa48 0.6dev: Fixed `php:phpunit` parsing including support for nested tests. Extended `php:coverage` to also parse PHPUnit coverage-clover format. Closes #199 and #316. osimons parents: 584 diff changeset	604 Extracts coverage information from Phing_'s code coverage task XML file or
4c3d43adaa48 0.6dev: Fixed `php:phpunit` parsing including support for nested tests. Extended `php:coverage` to also parse PHPUnit coverage-clover format. Closes #199 and #316. osimons parents: 584 diff changeset	605 from PHPUnit_ coverage-clover XML file.
416 ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	606
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	607 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	608 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	609
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	610 +---------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	611 \| Name \| Description \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	612 +===============+===========================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	613 \| ``file`` \| Path to the XML coverage file, relative to the project \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	614 \| \| source directory. \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	615 +---------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	616
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	617 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	618 --------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	619
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	620 .. code-block:: xml
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	621
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	622 <php:coverage file="build/coverage.xml" />
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	623
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	624
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	625 Python Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	626 ============
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	627
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	628 A bundle of recipe commands that support tools commonly used by Python_
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	629 projects.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	630
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	631 :Namespace: ``http://bitten.cmlenz.net/tools/python``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	632 :Common prefix: ``python``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	633
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	634 .. _python: http://www.python.org/
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	635
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	636
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	637 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	638 ``<python:exec>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	639 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	640
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	641 Executes a Python script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	642
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	643 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	644 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	645
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	646 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	647 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	648 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	649 \| ``file`` \| Path of the script to execute, relative to the project \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	650 \| \| source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	651 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	652 \| ``module`` \| Name of the Python module to execute. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	653 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	654 \| ``function`` \| Name of the function in the Python module to run. Only \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	655 \| \| works when also specifying the `module` attribute. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	656 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	657 \| ``args`` \| Any arguments that should be passed to the script. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	658 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	659 \| ``output`` \| Path to a file where any output by the script should be \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	660 \| \| recorded. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	661 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	662
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	663 Either `file` or `module` must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	664
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	665 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	666 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	667
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	668 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	669
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	670 <python:exec module="pylint.lint" output="pylint-report.txt" args="myproj" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	671
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	672 Executes Pylint_ on the module/package ``myproj`` and stores the output into a
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	673 file named ``pylint-report.txt``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	674
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	675 Configuration
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	676 -------------
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	677
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	678 .. code-block:: ini
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	679
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	680 [python]
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	681 path = /path/to/python
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	682
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	683
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	684 ----------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	685 ``<python:distutils>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	686 ----------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	687
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	688 Executes a distutils_ script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	689
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	690 .. _distutils: http://docs.python.org/lib/module-distutils.html
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	691
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	692 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	693 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	694
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	695 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	696 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	697 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	698 \| `command` \| The name of the `distutils` command that should be run \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	699 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	700 \| `options` \| Additional options to pass to the command, separated by \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	701 \| \| spaces \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	702 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	703
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	704 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	705 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	706
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	707 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	708
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	709 <python:distutils command="sdist" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	710
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	711 Instructs `distutils` to produce a source distribution.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	712
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	713 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	714
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	715 <python:distutils command="unittest" options="
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	716 --xml-output build/test-results.xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	717 --coverage-summary build/test-coverage.txt
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	718 --coverage-dir build/coverage"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	719
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	720 Instructs `distutils` to run the ``unittest`` command (which is provided by
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	721 Bitten), and passes the options needed to determine the output paths for test
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	722 results and code coverage reports.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	723
599 b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	724 Configuration
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	725 -------------
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	726
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	727 .. code-block:: ini
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	728
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	729 [python]
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	730 path = /path/to/python
b76e6accad72 0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code. osimons parents: 597 diff changeset	731
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	732
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	733 ---------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	734 ``<python:unittest>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	735 ---------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	736
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	737 Extracts information from unittest_ results recorded in an XML file.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	738
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	739 .. _unittest: http://docs.python.org/lib/module-unittest.html
633 900b09af6b38 0.6dev: The `.. note` rst processor don't seem to be found anywhere anymore. Replacing with a bold `Note:` before message text. osimons parents: 629 diff changeset	740
900b09af6b38 0.6dev: The `.. note` rst processor don't seem to be found anywhere anymore. Replacing with a bold `Note:` before message text. osimons parents: 629 diff changeset	741 Note: This report must be used in conjunction with the ``distutils``
900b09af6b38 0.6dev: The `.. note` rst processor don't seem to be found anywhere anymore. Replacing with a bold `Note:` before message text. osimons parents: 629 diff changeset	742 command "unittest" that comes with Bitten.
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	743
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	744 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	745 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	746
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	747 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	748 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	749 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	750 \| ``file`` \| Path to the XML results file, relative to the project \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	751 \| \| source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	752 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	753
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	754 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	755 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	756
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	757 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	758
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	759 <python:unittest file="build/test-results.xml"/>
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	760
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	761 Extracts the test results from the XML file located at
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	762 ``build/test-results.xml``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	763
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	764
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	765 ------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	766 ``<python:trace>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	767 ------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	768
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	769 Extracts coverage information recorded by the built-in Python module
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	770 ``trace.py``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	771
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	772 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	773 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	774
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	775 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	776 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	777 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	778 \| ``summary`` \| Path to the summary file written by ``trace.py``, \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	779 \| \| relative to the project source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	780 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	781 \| ``coverdir`` \| Path to the directory containing the coverage files written \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	782 \| \| by ``trace.py``, relative to the project source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	783 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	784 \| ``include`` \| List of glob patterns (separated by space) that specify \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	785 \| \| which Python file should be included in the coverage report \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	786 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	787 \| ``exclude`` \| List of glob patterns (separated by space) that specify \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	788 \| \| which Python file should be excluded from the coverage \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	789 \| \| report \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	790 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	791
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	792 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	793 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	794
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	795 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	796
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	797 <python:trace summary="build/trace.out" coverdir="build/coverage" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	798
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	799 -------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	800 ``<python:pylint>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	801 -------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	802
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	803 Extracts information from Pylint_ reports.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	804
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	805 .. _pylint: http://www.logilab.org/projects/pylint
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	806
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	807 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	808 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	809
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	810 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	811 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	812 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	813 \| ``file`` \| Path to the file containing the Pylint output, relative to \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	814 \| \| the project source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	815 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	816
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	817 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	818 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	819
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	820 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	821
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	822 <python:pylint file="build/pylint.out" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	823
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	824
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	825 Subversion Tools
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	826 ================
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	827
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	828 A collection of recipe commands for working with the Subversion_ version
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	829 control system. This commands are commonly used as the first step of a build
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	830 recipe to actually pull the code that should be built from the repository.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	831
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	832 .. _subversion: http://subversion.tigris.org/
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	833
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	834 :Namespace: ``http://bitten.cmlenz.net/tools/svn``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	835 :Common prefix: ``svn``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	836
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	837
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	838 ------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	839 ``<svn:checkout>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	840 ------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	841
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	842 Check out a working copy from a Subversion repository.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	843
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	844 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	845 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	846
505 4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	847 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	848 \| Name \| Description \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	849 +=================+=============================================================+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	850 \| ``url`` \| URL of the repository. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	851 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	852 \| ``path`` \| The path inside the repository that should be checked out. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	853 \| \| You should normally set this to ``${path}`` so that the \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	854 \| \| path of the build configuration is used. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	855 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	856 \| ``revision`` \| The revision that should be checked out. You should \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	857 \| \| normally set this to ``${revision}`` so that the revision \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	858 \| \| of the build is used. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	859 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	860 \| ``dir`` \| Path specifying which directory the sources should be \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	861 \| \| checked out to (defaults to '.'). \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	862 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	863 \| ``verbose`` \| Whether to log the list of checked out files (defaults to \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	864 \| \| False). \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	865 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	866 \| ``shared_path`` \| An optional shared directory to check the sources out in, \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	867 \| \| which will be reused for each subsequent build. This is \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	868 \| \| relative to the project directory, so for standard usage \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	869 \| \| set it to something like ``../trunk`` \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	870 +-----------------+-------------------------------------------------------------+
564 2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	871 \| ``username`` \| Username to pass for authentication (optional) \|
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	872 +-----------------+-------------------------------------------------------------+
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	873 \| ``password`` \| Password to pass for authentication (optional) \|
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	874 +-----------------+-------------------------------------------------------------+
491 9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	875
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	876
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	877 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	878 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	879
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	880 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	881
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	882 <svn:checkout url="http://svn.example.org/repos/myproject/"
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	883 path="${path}" revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	884
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	885 This checks out the a working copy into the current directory.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	886
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	887
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	888 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	889 ``<svn:export>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	890 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	891
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	892 Download a file or directory from a Subversion repository. This is similar to
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	893 performing a checkout, but will not include the meta-data Subversion uses to
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	894 connect the local working copy to the repository (i.e. it does not include the
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	895 ``.svn`` directories.)
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	896
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	897 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	898 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	899
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	900 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	901 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	902 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	903 \| ``url`` \| URL of the repository. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	904 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	905 \| ``path`` \| The path inside the repository that should be checked out. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	906 \| \| You should normally set this to ``${path}`` so that the \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	907 \| \| path of the build configuration is used. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	908 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	909 \| ``revision`` \| The revision that should be checked out. You should \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	910 \| \| normally set this to ``${revision}`` so that the revision \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	911 \| \| of the build is used. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	912 +--------------+-------------------------------------------------------------+
491 9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	913 \| ``dir`` \| Path specifying which directory the sources should be \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	914 \| \| exported to (defaults to '.') \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	915 +--------------+-------------------------------------------------------------+
564 2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	916 \| ``username`` \| Username to pass for authentication (optional) \|
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	917 +--------------+-------------------------------------------------------------+
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	918 \| ``password`` \| Password to pass for authentication (optional) \|
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	919 +--------------+-------------------------------------------------------------+
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	920
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	921 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	922 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	923
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	924 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	925
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	926 <svn:export url="http://svn.example.org/repos/myproject/"
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	927 path="${path}" revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	928
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	929 This downloads the file or directory at ``${path}`` from the Subversion
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	930 repository at ``http://svn.example.org/repos/myproject/``. Variables are used
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	931 for the ``path`` and ``revision`` attributes so they are populated from the
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	932 properties of the build and build configuration.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	933
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	934
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	935 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	936 ``<svn:update>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	937 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	938
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	939 Update an existing working copy from a Subversion repository to a specific
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	940 revision.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	941
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	942 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	943 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	944
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	945 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	946 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	947 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	948 \| ``revision`` \| The revision that should be checked out. You should \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	949 \| \| normally set this to ``${revision}`` so that the revision \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	950 \| \| of the build is used. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	951 +--------------+-------------------------------------------------------------+
491 9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	952 \| ``dir`` \| Path specifying the directory containing the sources to be \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	953 \| \| updated (defaults to '.') \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	954 +--------------+-------------------------------------------------------------+
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	955
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	956 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	957 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	958
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	959 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	960
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	961 <svn:update revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	962
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	963 This updates the working copy in the current directory. The revision is
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	964 specified as a variable so that it is populated from the properties of the
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	965 build.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	966
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	967
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	968 XML Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	969 =========
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	970
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	971 A collection of recipe commands for XML processing.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	972
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	973 :Namespace: ``http://bitten.cmlenz.net/tools/xml``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	974 :Common prefix: ``x``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	975
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	976
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	977 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	978 ``<x:transform>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	979 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	980
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	981 Apply an XSLT stylesheet .
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	982
633 900b09af6b38 0.6dev: The `.. note` rst processor don't seem to be found anywhere anymore. Replacing with a bold `Note:` before message text. osimons parents: 629 diff changeset	983 Note: This command requires either libxslt_ (with `Python bindings`_)
900b09af6b38 0.6dev: The `.. note` rst processor don't seem to be found anywhere anymore. Replacing with a bold `Note:` before message text. osimons parents: 629 diff changeset	984 or, on Windows platforms, MSXML (version 3 or later) to be installed
900b09af6b38 0.6dev: The `.. note` rst processor don't seem to be found anywhere anymore. Replacing with a bold `Note:` before message text. osimons parents: 629 diff changeset	985 on the slave machine.
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	986
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	987 .. _libxslt: http://xmlsoft.org/XSLT/
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	988 .. _`python bindings`: http://xmlsoft.org/XSLT/python.html
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	989
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	990 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	991 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	992
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	993 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	994 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	995 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	996 \| ``src`` \| Path of the source XML file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	997 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	998 \| ``dest`` \| Path of the destition XML file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	999 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	1000 \| ``stylesheet`` \| Path to the XSLT stylesheet file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	1001 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1002
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1003 All these are interpreted relative to the project source directory.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1004
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1005 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1006 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1007
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1008 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1009
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1010 <x:transform src="src.xml" dest="dest.xml" stylesheet="util/convert.xsl" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1011
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1012 This applies the stylesheet in ``util/convert.xsl`` to the source file
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	1013 ``src.xml``, and writes the resulting XML document to ``dest.xml``.
584 d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1014
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1015
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1016 Mercurial Tools
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1017 ===============
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1018
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1019 A collection of recipe commands for working with Mercurial_ (hg) repositories.
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1020
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1021 .. _mercurial: http://mercurial.selenic.com/
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1022
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1023
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1024 :Namespace: ``http://bitten.cmlenz.net/tools/hg``
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1025 :Common prefix: ``hg``
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1026
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1027
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1028 -------------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1029 ``<hg:pull>``
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1030 -------------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1031
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1032 Pull changesets and updates a local Mercurial repository.
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1033
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1034 As the command depends on a pre-existing repository, bitten-slave must be
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1035 started with ``--build-dir=`` option for locating and working with the
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1036 repository.
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1037
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1038 Parameters
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1039 ----------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1040
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1041 +----------------+-----------------------------------------------------------+
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1042 \| Name \| Description \|
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1043 +================+===========================================================+
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1044 \| ``revision`` \| The revision to update to (optional, defaults to tip). \|
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1045 +----------------+-----------------------------------------------------------+
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1046 \| ``dir`` \| Local subdirectory with repository (optional, \|
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1047 \| \| defaults to '.'). \|
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1048 +----------------+-----------------------------------------------------------+
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1049
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1050 Paths are interpreted relative to the project source directory.
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1051
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1052 Examples
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1053 --------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1054
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1055 .. code-block:: xml
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1056
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1057 <hg:pull revision="${revision}" dir="src" />
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1058
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1059 This updates the repository in ``src`` to the revision of the current build.

Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 645:8c824b14e1c5