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

annotate doc/commands.txt @ 753:d9f06a314db5 0.6.x

Merge [830] from trunk.

author	wbell
date	Sat, 24 Apr 2010 13:34:45 +0000
parents	1f03b23e38ff
children	3e22750b4168

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

Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 753:d9f06a314db5 0.6.x