Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 683:0c4fec90c8e2

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