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

annotate doc/commands.txt @ 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. Thanks to all those that have helped develop the patch, and special thanks to Roland Wilczek for contributing, testing and helping me get working php builds for development.

author	osimons
date	Wed, 29 Jul 2009 10:43:48 +0000
parents	d8eb5f723371
children	b76e6accad72

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

Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 597:4c3d43adaa48