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