Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 491:9bff10727d58

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