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

annotate doc/commands.txt @ 818:fc90ef7b2b86

Moving the wiki:ReportFormats page into the repository.

author	osimons
date	Thu, 16 Sep 2010 09:35:36 +0000
parents	3e22750b4168
children	630b48a53fc6

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

Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 818:fc90ef7b2b86