Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 416:ff35be7d2a5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add PHP recipe commands contributed by Wei Zhuo.
author cmlenz
date Wed, 08 Aug 2007 12:43:16 +0000
parents b4ec24092b54
children 9d1631a751f8
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
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
130 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
131 ``<c:configure>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
132 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
133
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
134 Executes a configure script as generated by Autoconf.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
135
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
136 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
137 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
138
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
139 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
140 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
141 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
142 | ``file`` | Name of the configure script (defaults to "configure") |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
143 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
144 | ``enable`` | List of features to enable, separated by spaces. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
145 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
146 | ``disable`` | List of features to disable, separated by spaces. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
147 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
148 | ``with`` | List of packages to include, separated by spaces. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
149 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
150 | ``without`` | List of packages to exclude, separated by spaces. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
151 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
152 | ``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
153 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
154 | ``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
155 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
156
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
157 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
158 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
159
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
160 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
161
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
162 <c:configure enable="threadsafe" cflags="O"/>
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
163
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
164 Runs the `configure` script in the base directory, enable the `threadsafe`
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
165 feature, and passing `-O` as `CFLAGS`. This is equivalent to::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
166
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
167 ./configure --enable-threadsafe CFLAGS="-O"
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
168
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
169
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
170 ------------
415
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
171 ``<c:gcov>``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
172 ------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
173
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
174 Run gcov_ to extract coverage data where available.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
175
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
176 .. _gcov: http://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
177
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
178 Parameters
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
179 ----------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
180
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
181 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
182 | Name | Description |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
183 +==============+============================================================+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
184 | ``include`` | List of glob patterns (separated by space) that specify |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
185 | | which source files should be included in the coverage |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
186 | | report |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
187 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
188 | ``exclude`` | List of glob patterns (separated by space) that specify |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
189 | | which source files should be excluded from the coverage |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
190 | | report |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
191 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
192 | ``prefix`` | Optional prefix name that is added to object files by the |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
193 | | build system |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
194 +--------------+------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
195
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
196
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
197 ------------
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
198 ``<c:make>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
199 ------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
200
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
201 Executes a Makefile.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
202
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
203 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
204 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
205
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
206 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
207 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
208 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
209 | ``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
210 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
211 | ``file`` | Path to the Makefile that should be used. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
212 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
213 | ``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
214 | | encountering errors. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
215 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
216
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
217 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
218 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
219
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
220 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
221
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
222 <c:make target="compile" file="build/Makefile" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
223
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
224 Runs the target "compile" of the ``Makefile`` located in the sub-directory
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
225 ``build``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
226
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
227
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
228 ---------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
229 ``<c:cppunit>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
230 ---------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
231
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
232 Report the test output generated by the CppUnit_ unit testing framework. The
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
233 output from CppUnit must be in XML format and in already, specified by the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
234 ``file`` argument of this recipe.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
235
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
236 .. _cppunit: http://cppunit.sourceforge.net
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
237
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
238 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
239 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
240
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
241 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
242 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
243 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
244 | ``file`` | Path to the cppunit XML output file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
245 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
246
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
247 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
248 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
249
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
250 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
251
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
252 <sh:exec executable="run_unit_tests" output="test_results.xml" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
253 <c:cppunit file="test_results.xml" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
254
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
255 Runs the program ``run_unit_tests`` to gather the data output by CppUnit in the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
256 ``test_results.xml`` file and then reports it.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
257
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
258
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
259 Java Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
260 ==========
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
261
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
262 A bundle of recipe commands that support tools commonly used by Java projects.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
263
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
264 :Namespace: ``http://bitten.cmlenz.net/tools/java``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
265 :Common prefix: ``java``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
266
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
267
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
268 --------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
269 ``<java:ant>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
270 --------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
271
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
272 Runs an Ant_ build.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
273
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
274 .. _ant: http://ant.apache.org/
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
275
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
276 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
277 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
278
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
279 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
280 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
281 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
282 | ``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
283 | | directory (default is ``build.xml``). |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
284 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
285 | ``target`` | Name of the build target(s) to execute. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
286 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
287 | ``args`` | Additional arguments to pass to Ant, separated by |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
288 | | whitespace. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
289 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
290 | ``keep_going`` | 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
291 | | in the build. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
292 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
293
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
294 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
295 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
296
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
297 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
298
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
299 <java:ant target="compile" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
300
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
301 Executes the target `compile` of the `build.xml` buildfile at the top of the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
302 project source directory.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
303
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
304
415
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
305 --------------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
306 ``<java:cobertura>``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
307 --------------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
308
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
309 Extract code coverage data from a Cobertura_ XML file.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
310
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
311 .. _cobertura: http://cobertura.sourceforge.net/
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
312
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
313 Parameters
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
314 ----------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
315
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
316 +----------------+-----------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
317 | Name | Description |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
318 +================+===========================================================+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
319 | ``file`` | Path to the XML file generated by Cobertura |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
320 +----------------+-----------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
321
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
322 Examples
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
323 --------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
324
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
325 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
326
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
327 <java:cobertura file="build/cobertura.xml" />
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
328
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
329 Reads the specifid XML file, extracts the coverage data, and builds a coverage
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
330 report to be sent to the build master.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
331
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
332
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
333 ----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
334 ``<java:junit>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
335 ----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
336
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
337 Extracts information about unit test results from a file in JUnit_ XML format.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
338
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
339 .. _junit: http://junit.org/index.htm
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
340
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
341 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
342 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
343
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
344 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
345 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
346 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
347 | ``file`` | Path to the JUnit XML test results file. This can include |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
348 | | wildcards, in which case all the file matching the |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
349 | | pattern will be included. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
350 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
351 | ``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
352 | | test cases to files. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
353 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
354
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
355 The ``file`` attribute is required.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
356
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
357 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
358 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
359
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
360 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
361
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
362 <java:junit file="build/tests/results/TEST-*.xml" srcdir="src/tests" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
363
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
364 Collects the test results from all files in the `build/tests/results` directory
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
365 that match the pattern `TEST-*.xml`. Also, maps the class names in the results
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
366 files to Java source files in the directory `src/tests`.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
367
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
368
416
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
369 PHP Tools
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
370 =========
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
371
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
372 A bundle of recipe commands for PHP_ projects.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
373
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
374 :Namespace: ``http://bitten.cmlenz.net/tools/php``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
375 :Common prefix: ``php``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
376
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
377 .. _php: http://php.net/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
378
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
379 ------------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
380 ``<python:phing>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
381 ------------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
382
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
383 Runs a Phing_ build.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
384
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
385 .. _phing: http://phing.info/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
386
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
387 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
388 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
389
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
390 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
391 | Name | Description |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
392 +===================+=======================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
393 | ``file`` | Path of the build file, relative to the project |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
394 | | source directory (default is ``build.xml``). |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
395 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
396 | ``target`` | Name of the build target(s) to execute. |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
397 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
398 | ``args`` | Additional arguments to pass to Phing, separated by |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
399 | | whitespace. |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
400 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
401 | ``executable`` | Phing executable program (default is ``phing``). |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
402 +-------------------+-------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
403
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
404
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
405 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
406 --------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
407
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
408 .. code-block:: xml
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
409
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
410 <php:phing target="compile" />
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
411
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
412 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
413 project source directory.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
414
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
415
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
416 -----------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
417 ``<php:phpunit>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
418 -----------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
419
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
420 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
421
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
422 .. _phpunit: http://www.phpunit.de/
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
423
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
424 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
425 ----------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
426
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
427 +----------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
428 | Name | Description |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
429 +================+===========================================================+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
430 | ``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
431 | | source directory. |
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 Examples
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
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
437 .. code-block:: xml
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:phpunit file="build/test-results.xml"/>
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
440
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
441 Extracts the test results from the XML file located at
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
442 ``build/test-results.xml``.
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
443
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 ------------------
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
446 ``<php:coverage>``
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
447 ------------------
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 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
450 file.
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 Parameters
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
453 ----------
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 +---------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
456 | Name | Description |
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 | ``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
459 | | source directory. |
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
460 +---------------+-----------------------------------------------------------+
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
461
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
462 Examples
ff35be7d2a5e Add PHP recipe commands contributed by Wei Zhuo.
cmlenz
parents: 415
diff changeset
463 --------
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 .. code-block:: xml
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 <php:coverage file="build/coverage.xml" />
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
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
470 Python Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
471 ============
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
472
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
473 A bundle of recipe commands that support tools commonly used by Python_
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
474 projects.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
475
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
476 :Namespace: ``http://bitten.cmlenz.net/tools/python``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
477 :Common prefix: ``python``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
478
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
479 .. _python: http://www.python.org/
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
480
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
481
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
482 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
483 ``<python:exec>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
484 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
485
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
486 Executes a Python script.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
487
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
488 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
489 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
490
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
491 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
492 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
493 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
494 | ``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
495 | | source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
496 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
497 | ``module`` | Name of the Python module to execute. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
498 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
499 | ``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
500 | | works when also specifying the `module` attribute. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
501 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
502 | ``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
503 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
504 | ``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
505 | | recorded. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
506 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
507
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
508 Either `file` or `module` must be specified.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
509
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
510 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
511 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
512
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
513 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
514
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
515 <python:exec module="pylint.lint" output="pylint-report.txt" args="myproj" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
516
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
517 Executes Pylint_ on the module/package ``myproj`` and stores the output into a
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
518 file named ``pylint-report.txt``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
519
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
520
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
521 ----------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
522 ``<python:distutils>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
523 ----------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
524
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
525 Executes a distutils_ script.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
526
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
527 .. _distutils: http://docs.python.org/lib/module-distutils.html
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
528
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
529 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
530 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
531
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
532 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
533 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
534 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
535 | `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
536 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
537 | `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
538 | | spaces |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
539 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
540
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
541 Examples
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 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
545
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
546 <python:distutils command="sdist" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
547
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
548 Instructs `distutils` to produce a source distribution.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
549
415
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
550 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
551
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
552 <python:distutils command="unittest" options="
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
553 --xml-output build/test-results.xml
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
554 --coverage-summary build/test-coverage.txt
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
555 --coverage-dir build/coverage"/>
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
556
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
557 Instructs `distutils` to run the ``unittest`` command (which is provided by
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
558 Bitten), and passes the options needed to determine the output paths for test
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
559 results and code coverage reports.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
560
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
561
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
562 ---------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
563 ``<python:unittest>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
564 ---------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
565
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
566 Extracts information from unittest_ results recorded in an XML file.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
567
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
568 .. _unittest: http://docs.python.org/lib/module-unittest.html
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
569 .. note:: This report must be used in conjunction with the ``distutils`` command
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
570 "unittest" that comes with Bitten.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
571
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
572 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
573 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
574
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
575 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
576 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
577 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
578 | ``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
579 | | source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
580 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
581
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
582 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
583 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
584
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
585 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
586
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
587 <python:unittest file="build/test-results.xml"/>
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
588
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
589 Extracts the test results from the XML file located at
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
590 ``build/test-results.xml``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
591
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
592
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
593 ------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
594 ``<python:trace>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
595 ------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
596
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
597 Extracts coverage information recorded by the built-in Python module
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
598 ``trace.py``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
599
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
600 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
601 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
602
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
603 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
604 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
605 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
606 | ``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
607 | | relative to the project source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
608 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
609 | ``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
610 | | by ``trace.py``, relative to the project source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
611 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
612 | ``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
613 | | 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
614 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
615 | ``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
616 | | which Python file should be excluded from the coverage |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
617 | | report |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
618 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
619
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
620 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
621 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
622
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
623 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
624
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
625 <python:trace summary="build/trace.out" coverdir="build/coverage" />
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 ``<python:pylint>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
629 -------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
630
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
631 Extracts information from Pylint_ reports.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
632
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
633 .. _pylint: http://www.logilab.org/projects/pylint
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
634
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
635 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
636 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
637
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
638 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
639 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
640 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
641 | ``file`` | Path to the file containing the Pylint output, relative to |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
642 | | the project source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
643 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
644
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
645 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
646 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
647
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
648 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
649
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
650 <python:pylint file="build/pylint.out" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
651
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
652
415
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
653 Subversion Tools
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
654 ================
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
655
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
656 A collection of recipe commands for working with the Subversion_ version
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
657 control system. This commands are commonly used as the first step of a build
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
658 recipe to actually pull the code that should be built from the repository.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
659
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
660 .. _subversion: http://subversion.tigris.org/
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
661
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
662 :Namespace: ``http://bitten.cmlenz.net/tools/svn``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
663 :Common prefix: ``svn``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
664
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
665
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
666 ------------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
667 ``<svn:checkout>``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
668 ------------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
669
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
670 Check out a working copy from a Subversion repository.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
671
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
672 Parameters
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
673 ----------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
674
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
675 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
676 | Name | Description |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
677 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
678 | ``url`` | URL of the repository. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
679 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
680 | ``path`` | The path inside the repository that should be checked out. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
681 | | You should normally set this to ``${path}`` so that the |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
682 | | path of the build configuration is used. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
683 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
684 | ``revision`` | The revision that should be checked out. You should |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
685 | | normally set this to ``${revision}`` so that the revision |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
686 | | of the build is used. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
687 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
688
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
689 Examples
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
690 --------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
691
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
692 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
693
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
694 <svn:checkout url="http://svn.example.org/repos/myproject/"
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
695 path="${path}" revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
696
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
697 This checks out the a working copy into the current directory.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
698
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
699
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
700 ----------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
701 ``<svn:export>``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
702 ----------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
703
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
704 Download a file or directory from a Subversion repository. This is similar to
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
705 performing a checkout, but will not include the meta-data Subversion uses to
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
706 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
707 ``.svn`` directories.)
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
708
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
709 Parameters
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
710 ----------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
711
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
712 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
713 | Name | Description |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
714 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
715 | ``url`` | URL of the repository. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
716 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
717 | ``path`` | The path inside the repository that should be checked out. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
718 | | You should normally set this to ``${path}`` so that the |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
719 | | path of the build configuration is used. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
720 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
721 | ``revision`` | The revision that should be checked out. You should |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
722 | | normally set this to ``${revision}`` so that the revision |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
723 | | of the build is used. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
724 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
725
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
726 Examples
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 .. code-block:: xml
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
730
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
731 <svn:export url="http://svn.example.org/repos/myproject/"
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
732 path="${path}" revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
733
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
734 This downloads the file or directory at ``${path}`` from the Subversion
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
735 repository at ``http://svn.example.org/repos/myproject/``. Variables are used
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
736 for the ``path`` and ``revision`` attributes so they are populated from the
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
737 properties of the build and build configuration.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
738
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
739
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
740 ----------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
741 ``<svn:update>``
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
742 ----------------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
743
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
744 Update an existing working copy from a Subversion repository to a specific
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
745 revision.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
746
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
747 Parameters
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
748 ----------
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
749
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
750 +--------------+-------------------------------------------------------------+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
751 | Name | Description |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
752 +==============+=============================================================+
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
753 | ``revision`` | The revision that should be checked out. You should |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
754 | | normally set this to ``${revision}`` so that the revision |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
755 | | of the build is used. |
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
756 +--------------+-------------------------------------------------------------+
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:update revision="${revision}"/>
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
764
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
765 This updates the working copy in the current directory. The revision is
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
766 specified as a variable so that it is populated from the properties of the
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
767 build.
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
768
b4ec24092b54 Updated recipe command documentation.
cmlenz
parents: 413
diff changeset
769
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
770 XML Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
771 =========
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
772
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
773 A collection of recipe commands for XML processing.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
774
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
775 :Namespace: ``http://bitten.cmlenz.net/tools/xml``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
776 :Common prefix: ``x``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
777
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
778
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
779 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
780 ``<x:transform>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
781 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
782
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
783 Apply an XSLT stylesheet .
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
784
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
785 .. note:: that this command requires either libxslt_ (with `Python bindings`_)
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
786 or, on Windows platforms, MSXML (version 3 or later) to be installed
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
787 on the slave machine.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
788
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
789 .. _libxslt: http://xmlsoft.org/XSLT/
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
790 .. _`python bindings`: http://xmlsoft.org/XSLT/python.html
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
791
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
792 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
793 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
794
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
795 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
796 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
797 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
798 | ``src`` | Path of the source XML file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
799 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
800 | ``dest`` | Path of the destition XML file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
801 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
802 | ``stylesheet`` | Path to the XSLT stylesheet file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
803 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
804
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
805 All these are interpreted relative to the project source directory.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
806
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
807 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
808 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
809
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
810 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
811
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
812 <x:transform src="src.xml" dest="dest.xml" stylesheet="util/convert.xsl" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
813
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
814 This applies the stylesheet in ``util/convert.xsl`` to the source file
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
815 ``src.xml``, and writes the resulting XML document to ``dest.xml``.
Copyright (C) 2012-2017 Edgewall Software