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

annotate doc/commands.txt @ 611:294641e84e89

0.6dev: Adding `${name}` and `${basedir}` (#325) for recipe substitution. Updated docs + new test.

author	osimons
date	Sat, 01 Aug 2009 01:56:14 +0000
parents	b76e6accad72
children	f3bb52da9e3c

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
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	50 Shell Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	51 ===========
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	52
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	53 A bundle of generic tools that are not specific to any programming language or
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	54 tool-chain.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	55
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	56 :Namespace: ``http://bitten.cmlenz.net/tools/sh``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	57 :Common prefix: ``sh``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	58
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	59
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	60 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	61 ``<sh:exec>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	62 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	63
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	64 Executes a program or script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	65
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	66 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	67 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	68
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	69 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	70 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	71 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	72 \| ``executable`` \| The name of the executable program. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	73 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	74 \| ``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	75 \| \| directory \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	76 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	77 \| ``output`` \| Path to the output file \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	78 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	79 \| ``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	80 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	81
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	82 Either ``executable`` or ``file`` must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	83
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	84 Examples
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 TODO
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	88
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 ``<sh:pipe>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	92 -------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	93
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	94 Pipes the content of a file through a program or script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	95
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	96 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	97 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	98
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	99 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	100 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	101 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	102 \| ``executable`` \| The name of the executable program. \|
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 \| ``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	105 \| \| directory \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	106 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	107 \| ``input`` \| Path to the input file \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	108 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	109 \| ``output`` \| Path to the output file \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	110 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	111 \| ``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	112 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	113
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	114 Either ``executable`` or ``file`` must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	115
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	116 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	117 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	118
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	119 TODO
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	120
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	121
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	122 C/Unix Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	123 ============
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	124
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	125 These commands provide support for tools commonly used for development of C/C++
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	126 applications on Unix platforms, such as ``make``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	127
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	128 :Namespace: ``http://bitten.cmlenz.net/tools/c``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	129 :Common prefix: ``c``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	130
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	131
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	132 ------------------
478 6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	133 ``<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	134 ------------------
478 6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	135
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	136 Executes ths autotool autoreconf.
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	137
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	138 Parameters
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	139 ----------
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	140
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	141 :param force: consider all files obsolete
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	142 :param install: copy missing auxiliary files
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	143 :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	144 :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	145 :prepend_include: prepend directories to search path
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	146 :include: append directories to search path
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	147
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	148
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	149 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	150 \| Name \| Description \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	151 +==============+=============================================================+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	152 \| ``force`` \| Consider all files obsolete \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	153 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	154 \| ``install`` \| Copy missing auxiliary files \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	155 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	156 \| ``symlink`` \| Install symbolic links instead of copies \|
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	157 +--------------+-------------------------------------------------------------+
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	158 \| ``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	159 \| \| (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	160 +--------------+-------------------------------------------------------------+
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	161 \| ``prepend_include`` \| Prepend directories to search path \|
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 \| ``include`` \| Append directories to search path \|
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
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	166 Examples
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
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	169 .. code-block:: xml
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	170
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	171 <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	172
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	173 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	174 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	175
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	176 autoreconf --force --install --warnings=cross,syntax,error
6718f9a5c1f1 Applying Thomas Mueller's patch for the autoreconf command. Closes #59 wbell parents: 432 diff changeset	177
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 -----------------
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	180 ``<c:configure>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	181 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	182
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	183 Executes a configure script as generated by Autoconf.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	184
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	185 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	186 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	187
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	188 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	189 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	190 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	191 \| ``file`` \| Name of the configure script (defaults to "configure") \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	192 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	193 \| ``enable`` \| List of features to enable, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	194 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	195 \| ``disable`` \| List of features to disable, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	196 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	197 \| ``with`` \| List of packages to include, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	198 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	199 \| ``without`` \| List of packages to exclude, separated by spaces. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	200 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	201 \| ``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	202 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	203 \| ``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	204 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	205
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	206 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	207 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	208
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	209 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	210
432 74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	211 <c:configure enable="threadsafe" cflags="-O"/>
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	212
432 74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	213 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	214 feature, and passing ``-O`` as ``CFLAGS``. This is equivalent to::
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	215
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	216 ./configure --enable-threadsafe CFLAGS="-O"
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	217
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	218 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	219 -------------
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	220
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	221 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	222
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	223 .. 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	224
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	225 [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	226 path = /path/to/mylib
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	227
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	228 ------------
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	229 ``<c:gcov>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	230 ------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	231
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	232 Run gcov_ to extract coverage data where available.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	233
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	234 .. _gcov: http://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	235
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	236 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	237 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	238
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	239 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	240 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	241 +==============+============================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	242 \| ``include`` \| List of glob patterns (separated by space) that specify \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	243 \| \| which source files should be included in the coverage \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	244 \| \| report \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	245 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	246 \| ``exclude`` \| List of glob patterns (separated by space) that specify \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	247 \| \| which source files should be excluded from the coverage \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	248 \| \| report \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	249 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	250 \| ``prefix`` \| Optional prefix name that is added to object files by the \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	251 \| \| build system \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	252 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	253
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	254
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	255 ------------
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	256 ``<c:make>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	257 ------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	258
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	259 Executes a Makefile.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	260
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	261 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	262 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	263
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	264 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	265 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	266 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	267 \| ``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	268 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	269 \| ``file`` \| Path to the Makefile that should be used. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	270 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	271 \| ``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	272 \| \| encountering errors. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	273 +----------------+-----------------------------------------------------------+
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	274 \| ``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	275 +----------------+-----------------------------------------------------------+
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	276 \| ``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	277 +----------------+-----------------------------------------------------------+
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	278 \| ``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	279 \| \| 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	280 \| \| ``"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	281 +----------------+-----------------------------------------------------------+
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	282
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	283 Examples
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 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	287
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	288 <c:make target="compile" file="build/Makefile" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	289
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	290 Runs the target "compile" of the ``Makefile`` located in the sub-directory
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	291 ``build``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	292
487 fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	293 .. 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	294
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	295 <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	296
fbd5bc3c2a48 At long last, applying patch supplied by Xavier Duret for #207. Closes #207. Thanks for the patch. wbell parents: 478 diff changeset	297 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	298 the makefile with the command line argument ``coverage=1``.
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	299
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	300 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	301 -------------
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	302
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	303 .. 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	304
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	305 [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	306 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	307
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	308 ---------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	309 ``<c:cppunit>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	310 ---------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	311
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	312 Report the test output generated by the CppUnit_ unit testing framework. The
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	313 output from CppUnit must be in XML format and in already, specified by the
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	314 ``file`` argument of this recipe.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	315
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	316 .. _cppunit: http://cppunit.sourceforge.net
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	317
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	318 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	319 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	320
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	321 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	322 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	323 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	324 \| ``file`` \| Path to the cppunit XML output file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	325 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	326
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	327 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	328 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	329
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	330 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	331
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	332 <sh:exec executable="run_unit_tests" output="test_results.xml" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	333 <c:cppunit file="test_results.xml" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	334
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	335 Runs the program ``run_unit_tests`` to gather the data output by CppUnit in the
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	336 ``test_results.xml`` file and then reports it.
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 Java Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	340 ==========
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	341
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	342 A bundle of recipe commands that support tools commonly used by Java projects.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	343
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	344 :Namespace: ``http://bitten.cmlenz.net/tools/java``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	345 :Common prefix: ``java``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	346
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	347
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	348 --------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	349 ``<java:ant>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	350 --------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	351
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	352 Runs an Ant_ build.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	353
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	354 .. _ant: http://ant.apache.org/
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	355
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	356 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	357 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	358
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	359 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	360 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	361 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	362 \| ``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	363 \| \| directory (default is ``build.xml``). \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	364 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	365 \| ``target`` \| Name of the build target(s) to execute. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	366 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	367 \| ``args`` \| Additional arguments to pass to Ant, separated by \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	368 \| \| whitespace. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	369 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	370 \| ``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	371 \| \| in the build. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	372 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	373
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	374 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	375 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	376
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	377 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	378
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	379 <java:ant target="compile" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	380
432 74c51f648466 Started some tests for the new admin interface. cmlenz parents: 422 diff changeset	381 Executes the target ``compile`` of the ``build.xml`` buildfile at the top of the
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	382 project source directory.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	383
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	384 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	385 -------------
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	386
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	387 .. 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	388
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	389 [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	390 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	391
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	392 [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	393 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	394
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	395
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	396 --------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	397 ``<java:cobertura>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	398 --------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	399
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	400 Extract code coverage data from a Cobertura_ XML file.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	401
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	402 .. _cobertura: http://cobertura.sourceforge.net/
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	403
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	404 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	405 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	406
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	407 +----------------+-----------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	408 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	409 +================+===========================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	410 \| ``file`` \| Path to the XML file generated by Cobertura \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	411 +----------------+-----------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	412
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	413 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	414 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	415
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	416 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	417
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	418 <java:cobertura file="build/cobertura.xml" />
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	419
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	420 Reads the specifid XML file, extracts the coverage data, and builds a coverage
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	421 report to be sent to the build master.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	422
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	423
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	424 ----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	425 ``<java:junit>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	426 ----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	427
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	428 Extracts information about unit test results from a file in JUnit_ XML format.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	429
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	430 .. _junit: http://junit.org/index.htm
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	431
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	432 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	433 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	434
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	435 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	436 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	437 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	438 \| ``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	439 \| \| wildcards, in which case all the file matching the \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	440 \| \| pattern will be included. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	441 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	442 \| ``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	443 \| \| test cases to files. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	444 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	445
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	446 The ``file`` attribute is required.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	447
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	448 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	449 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	450
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	451 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	452
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	453 <java:junit file="build/tests/results/TEST-*.xml" srcdir="src/tests" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	454
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	455 Collects the test results from all files in the `build/tests/results` directory
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	456 that match the pattern `TEST-*.xml`. Also, maps the class names in the results
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	457 files to Java source files in the directory `src/tests`.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	458
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	459
550 6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	460 Mono Tools
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	461 ==========
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	462
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	463 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	464
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	465 :Namespace: ``http://bitten.cmlenz.net/tools/mono``
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	466 :Common prefix: ``mono``
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	467
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	468 ----------------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	469 ``<mono:nunit>``
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	470 ----------------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	471
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	472 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	473
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	474 .. _nunit: http://nunit.org/
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	475
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	476 Parameters
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	477 ----------
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	478
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	479 +----------------+-----------------------------------------------------------+
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	480 \| Name \| Description \|
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	481 +================+===========================================================+
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	482 \| ``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	483 \| \| 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	484 \| \| pattern will be included. \|
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	485 +----------------+-----------------------------------------------------------+
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	486
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	487 The ``file`` attribute is required.
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 Examples
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	490 --------
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 .. code-block:: xml
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	493
6a8dcbffdce2 Added support for nunit (applied patch from silk in #348) dfraser parents: 505 diff changeset	494 <mono:nunit file="build/tests/TestResult.xml" />
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
416 ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	497 PHP Tools
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	498 =========
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	499
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	500 A bundle of recipe commands for PHP_ projects.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	501
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	502 :Namespace: ``http://bitten.cmlenz.net/tools/php``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	503 :Common prefix: ``php``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	504
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	505 .. _php: http://php.net/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	506
422 9d1631a751f8 Fix typo in recipe commands reference. Closes #162. cmlenz parents: 416 diff changeset	507 ---------------
9d1631a751f8 Fix typo in recipe commands reference. Closes #162. cmlenz parents: 416 diff changeset	508 ``<php:phing>``
9d1631a751f8 Fix typo in recipe commands reference. Closes #162. cmlenz parents: 416 diff changeset	509 ---------------
416 ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	510
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	511 Runs a Phing_ build.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	512
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	513 .. _phing: http://phing.info/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	514
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	515 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	516 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	517
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	518 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	519 \| Name \| Description \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	520 +===================+=======================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	521 \| ``file`` \| Path of the build file, relative to the project \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	522 \| \| source directory (default is ``build.xml``). \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	523 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	524 \| ``target`` \| Name of the build target(s) to execute. \|
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 \| ``args`` \| Additional arguments to pass to Phing, separated by \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	527 \| \| whitespace. \|
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 \| ``executable`` \| Phing executable program (default is ``phing``). \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	530 +-------------------+-------------------------------------------------------+
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
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	533 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	534 --------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	535
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	536 .. code-block:: xml
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 <php:phing target="compile" />
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 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	541 project source directory.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	542
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 ``<php:phpunit>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	546 -----------------
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 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	549
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	550 .. _phpunit: http://www.phpunit.de/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	551
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	552 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	553 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	554
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 \| Name \| Description \|
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 \| ``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	559 \| \| source directory. \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	560 +----------------+-----------------------------------------------------------+
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 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	563 --------
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 .. code-block:: xml
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 <php:phpunit file="build/test-results.xml"/>
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	568
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	569 Extracts the test results from the XML file located at
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	570 ``build/test-results.xml``.
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
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 ``<php:coverage>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	575 ------------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	576
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	577 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	578 from PHPUnit_ coverage-clover XML file.
416 ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	579
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	580 Parameters
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 +---------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	584 \| Name \| Description \|
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	585 +===============+===========================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	586 \| ``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	587 \| \| source directory. \|
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
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	590 Examples
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
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	593 .. code-block:: xml
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	594
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	595 <php:coverage file="build/coverage.xml" />
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	596
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo. cmlenz parents: 415 diff changeset	597
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	598 Python Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	599 ============
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	600
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	601 A bundle of recipe commands that support tools commonly used by Python_
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	602 projects.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	603
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	604 :Namespace: ``http://bitten.cmlenz.net/tools/python``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	605 :Common prefix: ``python``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	606
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	607 .. _python: http://www.python.org/
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	608
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	609
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	610 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	611 ``<python:exec>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	612 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	613
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	614 Executes a Python script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	615
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	616 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	617 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	618
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	619 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	620 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	621 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	622 \| ``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	623 \| \| source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	624 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	625 \| ``module`` \| Name of the Python module to execute. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	626 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	627 \| ``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	628 \| \| works when also specifying the `module` attribute. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	629 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	630 \| ``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	631 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	632 \| ``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	633 \| \| recorded. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	634 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	635
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	636 Either `file` or `module` must be specified.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	637
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	638 Examples
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 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	642
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	643 <python:exec module="pylint.lint" output="pylint-report.txt" args="myproj" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	644
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	645 Executes Pylint_ on the module/package ``myproj`` and stores the output into a
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	646 file named ``pylint-report.txt``.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	647
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	648 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	649 -------------
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	650
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	651 .. 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	652
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	653 [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	654 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	655
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	656
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	657 ----------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	658 ``<python:distutils>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	659 ----------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	660
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	661 Executes a distutils_ script.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	662
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	663 .. _distutils: http://docs.python.org/lib/module-distutils.html
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	664
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	665 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	666 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	667
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	668 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	669 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	670 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	671 \| `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	672 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	673 \| `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	674 \| \| spaces \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	675 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	676
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	677 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	678 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	679
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	680 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	681
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	682 <python:distutils command="sdist" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	683
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	684 Instructs `distutils` to produce a source distribution.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	685
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	686 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	687
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	688 <python:distutils command="unittest" options="
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	689 --xml-output build/test-results.xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	690 --coverage-summary build/test-coverage.txt
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	691 --coverage-dir build/coverage"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	692
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	693 Instructs `distutils` to run the ``unittest`` command (which is provided by
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	694 Bitten), and passes the options needed to determine the output paths for test
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	695 results and code coverage reports.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	696
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	697 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	698 -------------
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	699
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	700 .. 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	701
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	702 [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	703 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	704
412 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 ``<python:unittest>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	708 ---------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	709
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	710 Extracts information from unittest_ results recorded in an XML file.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	711
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	712 .. _unittest: http://docs.python.org/lib/module-unittest.html
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	713 .. note:: This report must be used in conjunction with the ``distutils`` command
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	714 "unittest" that comes with Bitten.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	715
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	716 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	717 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	718
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	719 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	720 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	721 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	722 \| ``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	723 \| \| source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	724 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	725
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	726 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	727 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	728
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	729 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	730
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	731 <python:unittest file="build/test-results.xml"/>
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	732
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	733 Extracts the test results from the XML file located at
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	734 ``build/test-results.xml``.
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 ------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	738 ``<python:trace>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	739 ------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	740
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	741 Extracts coverage information recorded by the built-in Python module
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	742 ``trace.py``.
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 \| ``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	751 \| \| relative to the project source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	752 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	753 \| ``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	754 \| \| by ``trace.py``, relative to the project source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	755 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	756 \| ``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	757 \| \| 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	758 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	759 \| ``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	760 \| \| which Python file should be excluded from the coverage \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	761 \| \| report \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	762 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	763
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	764 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	765 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	766
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	767 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	768
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	769 <python:trace summary="build/trace.out" coverdir="build/coverage" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	770
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	771 -------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	772 ``<python:pylint>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	773 -------------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	774
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	775 Extracts information from Pylint_ reports.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	776
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	777 .. _pylint: http://www.logilab.org/projects/pylint
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	778
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	779 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	780 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	781
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	782 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	783 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	784 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	785 \| ``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	786 \| \| the project source directory. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	787 +--------------+-------------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	788
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	789 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	790 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	791
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	792 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	793
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	794 <python:pylint file="build/pylint.out" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	795
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	796
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	797 Subversion Tools
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	798 ================
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	799
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	800 A collection of recipe commands for working with the Subversion_ version
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	801 control system. This commands are commonly used as the first step of a build
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	802 recipe to actually pull the code that should be built from the repository.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	803
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	804 .. _subversion: http://subversion.tigris.org/
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	805
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	806 :Namespace: ``http://bitten.cmlenz.net/tools/svn``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	807 :Common prefix: ``svn``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	808
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	809
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	810 ------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	811 ``<svn:checkout>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	812 ------------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	813
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	814 Check out a working copy from a Subversion repository.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	815
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	816 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	817 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	818
505 4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	819 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	820 \| Name \| Description \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	821 +=================+=============================================================+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	822 \| ``url`` \| URL of the repository. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	823 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	824 \| ``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	825 \| \| 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	826 \| \| path of the build configuration is used. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	827 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	828 \| ``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	829 \| \| 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	830 \| \| of the build is used. \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	831 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	832 \| ``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	833 \| \| checked out to (defaults to '.'). \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	834 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	835 \| ``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	836 \| \| False). \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	837 +-----------------+-------------------------------------------------------------+
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	838 \| ``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	839 \| \| 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	840 \| \| 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	841 \| \| set it to something like ``../trunk`` \|
4caa400abe8e This alters the `svn:checkout` command to take an extra parameter, dfraser parents: 491 diff changeset	842 +-----------------+-------------------------------------------------------------+
564 2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	843 \| ``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	844 +-----------------+-------------------------------------------------------------+
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	845 \| ``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	846 +-----------------+-------------------------------------------------------------+
491 9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	847
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	848
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	849 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	850 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	851
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	852 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	853
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	854 <svn:checkout url="http://svn.example.org/repos/myproject/"
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	855 path="${path}" revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	856
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	857 This checks out the a working copy into the current directory.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	858
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	859
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	860 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	861 ``<svn:export>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	862 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	863
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	864 Download a file or directory from a Subversion repository. This is similar to
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	865 performing a checkout, but will not include the meta-data Subversion uses to
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	866 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	867 ``.svn`` directories.)
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	868
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	869 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	870 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	871
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	872 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	873 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	874 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	875 \| ``url`` \| URL of the repository. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	876 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	877 \| ``path`` \| The path inside the repository that should be checked out. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	878 \| \| You should normally set this to ``${path}`` so that the \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	879 \| \| path of the build configuration is used. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	880 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	881 \| ``revision`` \| The revision that should be checked out. You should \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	882 \| \| normally set this to ``${revision}`` so that the revision \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	883 \| \| of the build is used. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	884 +--------------+-------------------------------------------------------------+
491 9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	885 \| ``dir`` \| Path specifying which directory the sources should be \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	886 \| \| exported to (defaults to '.') \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	887 +--------------+-------------------------------------------------------------+
564 2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	888 \| ``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	889 +--------------+-------------------------------------------------------------+
2145ec6680fd Allow passing `username` and `password` to subversion `checkout` and `export` (fixes #349) dfraser parents: 550 diff changeset	890 \| ``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	891 +--------------+-------------------------------------------------------------+
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	892
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	893 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	894 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	895
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	896 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	897
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	898 <svn:export url="http://svn.example.org/repos/myproject/"
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	899 path="${path}" revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	900
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	901 This downloads the file or directory at ``${path}`` from the Subversion
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	902 repository at ``http://svn.example.org/repos/myproject/``. Variables are used
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	903 for the ``path`` and ``revision`` attributes so they are populated from the
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	904 properties of the build and build configuration.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	905
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	906
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	907 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	908 ``<svn:update>``
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	909 ----------------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	910
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	911 Update an existing working copy from a Subversion repository to a specific
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	912 revision.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	913
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	914 Parameters
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	915 ----------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	916
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	917 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	918 \| Name \| Description \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	919 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	920 \| ``revision`` \| The revision that should be checked out. You should \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	921 \| \| normally set this to ``${revision}`` so that the revision \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	922 \| \| of the build is used. \|
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	923 +--------------+-------------------------------------------------------------+
491 9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	924 \| ``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	925 \| \| updated (defaults to '.') \|
9bff10727d58 Documentation update for svn commands, supplied by Iain Haslam. wbell parents: 487 diff changeset	926 +--------------+-------------------------------------------------------------+
415 b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	927
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	928 Examples
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	929 --------
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	930
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	931 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	932
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	933 <svn:update revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	934
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	935 This updates the working copy in the current directory. The revision is
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	936 specified as a variable so that it is populated from the properties of the
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	937 build.
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	938
b4ec24092b54 Updated recipe command documentation. cmlenz parents: 413 diff changeset	939
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	940 XML Tools
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	941 =========
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	942
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	943 A collection of recipe commands for XML processing.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	944
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	945 :Namespace: ``http://bitten.cmlenz.net/tools/xml``
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	946 :Common prefix: ``x``
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	947
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	948
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	949 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	950 ``<x:transform>``
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	951 -----------------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	952
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	953 Apply an XSLT stylesheet .
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	954
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	955 .. note:: that this command requires either libxslt_ (with `Python bindings`_)
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	956 or, on Windows platforms, MSXML (version 3 or later) to be installed
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	957 on the slave machine.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	958
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	959 .. _libxslt: http://xmlsoft.org/XSLT/
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	960 .. _`python bindings`: http://xmlsoft.org/XSLT/python.html
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	961
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	962 Parameters
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	963 ----------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	964
413 fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	965 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	966 \| Name \| Description \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	967 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	968 \| ``src`` \| Path of the source XML file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	969 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	970 \| ``dest`` \| Path of the destition XML file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	971 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	972 \| ``stylesheet`` \| Path to the XSLT stylesheet file. \|
fa72698e7477 Don't put tables in blockquotes in command reference. cmlenz parents: 412 diff changeset	973 +----------------+-----------------------------------------------------------+
412 84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	974
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	975 All these are interpreted relative to the project source directory.
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	976
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	977 Examples
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	978 --------
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	979
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	980 .. code-block:: xml
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	981
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	982 <x:transform src="src.xml" dest="dest.xml" stylesheet="util/convert.xsl" />
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	983
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	984 This applies the stylesheet in ``util/convert.xsl`` to the source file
84b8cde2dfd4 Start with documentation. cmlenz parents: diff changeset	985 ``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	986
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	987
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	988 Mercurial Tools
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	989 ===============
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	990
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	991 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	992
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	993 .. _mercurial: http://mercurial.selenic.com/
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	994
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	995
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	996 :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	997 :Common prefix: ``hg``
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	998
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	999
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1000 -------------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1001 ``<hg:pull>``
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1002 -------------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1003
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1004 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	1005
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1006 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	1007 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	1008 repository.
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1009
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1010 Parameters
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1011 ----------
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1012
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1013 +----------------+-----------------------------------------------------------+
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1014 \| Name \| Description \|
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 \| ``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	1017 +----------------+-----------------------------------------------------------+
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1018 \| ``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	1019 \| \| defaults to '.'). \|
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
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1022 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	1023
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1024 Examples
d8eb5f723371 0.6dev: Adding documentation + minimal test for new `hg:pull` command, see #303. osimons parents: 564 diff changeset	1025 --------
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 .. code-block:: xml
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 revision="${revision}" dir="src" />
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 This updates the repository in ``src`` to the revision of the current build.

Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 611:294641e84e89