Mercurial > bitten > bitten-test

annotate doc/commands.txt @ 414:aa34d82b2c9a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
The build slave can now run locally against a recipe file, which is useful for testing recipes. Simply pass the path to the recipe instead of the URL of the build master to the script.
author cmlenz
date Wed, 08 Aug 2007 12:10:46 +0000
parents fa72698e7477
children b4ec24092b54
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
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
7 Build recipes are represented by XML documents. This page describes what
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
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
12 .. contents:: Contents
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
13 :depth: 2
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
14 .. sectnum::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
15
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
16
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
17 Generic Commands
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
18 ================
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
19
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
20 These are commands that are used without a namespace prefix.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
21
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
22
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
23 ------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
24 ``<report>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
25 ------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
26
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
27 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
28 Use this command in conjunction with the ``<sh:pipe>`` or ``<x:transform>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
29 commands to send custom reports to the build master.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
30
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
31 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
32 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
33
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
34 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
35 | Name | Description |
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 | ``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
38 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
39 | ``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
40 | | to the project directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
41 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
42
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
43 Both parameters must be specified.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
44
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
45
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
46 Shell Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
47 ===========
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
48
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
49 A bundle of generic tools that are not specific to any programming language or
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
50 tool-chain.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
51
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
52 :Namespace: ``http://bitten.cmlenz.net/tools/sh``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
53 :Common prefix: ``sh``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
54
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
55
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
56 -------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
57 ``<sh:exec>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
58 -------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
59
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
60 Executes a program or script.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
61
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
62 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
63 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
64
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
65 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
66 | Name | Description |
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 | ``executable`` | The name of the executable program. |
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 | ``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
71 | | directory |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
72 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
73 | ``output`` | Path to the output file |
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 | ``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
76 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
77
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
78 Either ``executable`` or ``file`` must be specified.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
79
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
80 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
81 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
82
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
83 TODO
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
84
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
85
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
86 -------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
87 ``<sh:pipe>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
88 -------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
89
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
90 Pipes the content of a file through a program or script.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
91
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
92 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
93 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
94
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
95 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
96 | Name | Description |
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 | ``executable`` | The name of the executable program. |
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 | ``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
101 | | directory |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
102 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
103 | ``input`` | Path to the input file |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
104 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
105 | ``output`` | Path to the output file |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
106 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
107 | ``args`` | Any arguments to pass to the executable or script |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
108 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
109
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
110 Either ``executable`` or ``file`` must be specified.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
111
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
112 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
113 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
114
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
115 TODO
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
116
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
117
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
118 C/Unix Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
119 ============
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
120
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
121 These commands provide support for tools commonly used for development of C/C++
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
122 applications on Unix platforms, such as ``make``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
123
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
124 :Namespace: ``http://bitten.cmlenz.net/tools/c``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
125 :Common prefix: ``c``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
126
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
127
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
128 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
129 ``<c:configure>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
130 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
131
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
132 Executes a configure script as generated by Autoconf.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
133
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
134 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
135 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
136
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
137 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
138 | Name | Description |
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 | ``file`` | Name of the configure script (defaults to "configure") |
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 | ``enable`` | List of features to enable, separated by spaces. |
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 | ``disable`` | List of features to disable, 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 | ``with`` | List of packages to include, 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 | ``without`` | List of packages to exclude, 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 | ``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
151 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
152 | ``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
153 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
154
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
155 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
156 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
157
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
158 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
159
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
160 <c:configure enable="threadsafe" cflags="O"/>
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
161
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
162 Runs the `configure` script in the base directory, enable the `threadsafe`
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
163 feature, and passing `-O` as `CFLAGS`. This is equivalent to::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
164
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
165 ./configure --enable-threadsafe CFLAGS="-O"
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
166
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
167
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
168 ------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
169 ``<c:make>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
170 ------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
171
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
172 Executes a Makefile.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
173
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
174 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
175 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
176
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
177 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
178 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
179 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
180 | ``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
181 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
182 | ``file`` | Path to the Makefile that should be used. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
183 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
184 | ``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
185 | | encountering errors. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
186 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
187
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
188 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
189 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
190
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
191 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
192
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
193 <c:make target="compile" file="build/Makefile" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
194
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
195 Runs the target "compile" of the ``Makefile`` located in the sub-directory
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
196 ``build``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
197
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
198
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
199 ---------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
200 ``<c:cppunit>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
201 ---------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
202
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
203 Report the test output generated by the CppUnit_ unit testing framework. The
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
204 output from CppUnit must be in XML format and in already, specified by the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
205 ``file`` argument of this recipe.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
206
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
207 .. _cppunit: http://cppunit.sourceforge.net
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
208
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
209 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
210 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
211
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
212 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
213 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
214 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
215 | ``file`` | Path to the cppunit XML output file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
216 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
217
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
218 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
219 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
220
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
221 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
222
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
223 <sh:exec executable="run_unit_tests" output="test_results.xml" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
224 <c:cppunit file="test_results.xml" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
225
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
226 Runs the program ``run_unit_tests`` to gather the data output by CppUnit in the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
227 ``test_results.xml`` file and then reports it.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
228
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
229
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
230 Java Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
231 ==========
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
232
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
233 A bundle of recipe commands that support tools commonly used by Java projects.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
234
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
235 :Namespace: ``http://bitten.cmlenz.net/tools/java``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
236 :Common prefix: ``java``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
237
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
238
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
239 --------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
240 ``<java:ant>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
241 --------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
242
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
243 Runs an Ant_ build.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
244
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
245 .. _ant: http://ant.apache.org/
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
246
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
247 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
248 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
249
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
250 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
251 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
252 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
253 | ``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
254 | | directory (default is ``build.xml``). |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
255 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
256 | ``target`` | Name of the build target(s) to execute. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
257 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
258 | ``args`` | Additional arguments to pass to Ant, separated by |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
259 | | whitespace. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
260 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
261 | ``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
262 | | in the build. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
263 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
264
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
265 Examples
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 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
269
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
270 <java:ant target="compile" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
271
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
272 Executes the target `compile` of the `build.xml` buildfile at the top of the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
273 project source directory.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
274
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
275
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
276 ----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
277 ``<java:junit>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
278 ----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
279
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
280 Extracts information about unit test results from a file in JUnit_ XML format.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
281
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
282 .. _junit: http://junit.org/index.htm
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
283
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
284 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
285 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
286
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
287 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
288 | Name | Description |
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 | ``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
291 | | wildcards, in which case all the file matching the |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
292 | | pattern will be included. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
293 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
294 | ``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
295 | | test cases to files. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
296 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
297
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
298 The ``file`` attribute is required.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
299
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
300 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
301 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
302
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
303 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
304
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
305 <java:junit file="build/tests/results/TEST-*.xml" srcdir="src/tests" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
306
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
307 Collects the test results from all files in the `build/tests/results` directory
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
308 that match the pattern `TEST-*.xml`. Also, maps the class names in the results
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
309 files to Java source files in the directory `src/tests`.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
310
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
311
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
312 Python Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
313 ============
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
314
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
315 A bundle of recipe commands that support tools commonly used by Python_
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
316 projects.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
317
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
318 :Namespace: ``http://bitten.cmlenz.net/tools/python``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
319 :Common prefix: ``python``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
320
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
321 .. _python: http://www.python.org/
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
322
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
323
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
324 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
325 ``<python:exec>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
326 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
327
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
328 Executes a Python script.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
329
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
330 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
331 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
332
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
333 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
334 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
335 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
336 | ``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
337 | | source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
338 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
339 | ``module`` | Name of the Python module to execute. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
340 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
341 | ``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
342 | | works when also specifying the `module` attribute. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
343 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
344 | ``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
345 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
346 | ``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
347 | | recorded. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
348 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
349
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
350 Either `file` or `module` must be specified.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
351
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
352 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
353 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
354
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
355 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
356
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
357 <python:exec module="pylint.lint" output="pylint-report.txt" args="myproj" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
358
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
359 Executes Pylint_ on the module/package ``myproj`` and stores the output into a
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
360 file named ``pylint-report.txt``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
361
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
362
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
363 ----------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
364 ``<python:distutils>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
365 ----------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
366
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
367 Executes a distutils_ script.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
368
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
369 .. _distutils: http://docs.python.org/lib/module-distutils.html
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
370
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
371 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
372 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
373
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
374 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
375 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
376 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
377 | `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
378 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
379 | `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
380 | | spaces |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
381 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
382
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
383 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
384 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
385
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
386 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
387
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
388 <python:distutils command="sdist" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
389
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
390 Instructs `distutils` to produce a source distribution.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
391
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
392
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
393 ---------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
394 ``<python:unittest>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
395 ---------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
396
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
397 Extracts information from unittest_ results recorded in an XML file.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
398
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
399 .. _unittest: http://docs.python.org/lib/module-unittest.html
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
400 .. note:: This report must be used in conjunction with the ``distutils`` command
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
401 "unittest" that comes with Bitten.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
402
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
403 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
404 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
405
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
406 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
407 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
408 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
409 | ``file`` | Path to the XML results file, relative to the project |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
410 | | source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
411 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
413 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
414 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
415
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
416 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
417
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
418 <python:unittest file="build/test-results.xml"/>
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
419
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
420 Extracts the test results from the XML file located at
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
421 ``build/test-results.xml``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
422
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
423
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
424 ------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
425 ``<python:trace>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
426 ------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
427
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
428 Extracts coverage information recorded by the built-in Python module
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
429 ``trace.py``.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
430
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
431 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
432 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
433
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
434 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
435 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
436 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
437 | ``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
438 | | relative to the project source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
439 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
440 | ``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
441 | | by ``trace.py``, relative to the project source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
442 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
443 | ``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
444 | | 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
445 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
446 | ``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
447 | | which Python file should be excluded from the coverage |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
448 | | report |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
449 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
450
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
451 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
452 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
453
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
454 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
455
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
456 <python:trace summary="build/trace.out" coverdir="build/coverage" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
457
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
458 -------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
459 ``<python:pylint>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
460 -------------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
461
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
462 Extracts information from Pylint_ reports.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
463
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
464 .. _pylint: http://www.logilab.org/projects/pylint
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
465
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
466 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
467 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
468
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
469 +--------------+-------------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
470 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
471 +==============+=============================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
472 | ``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
473 | | the project source directory. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
474 +--------------+-------------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
475
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
476 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
477 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
478
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
479 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
480
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
481 <python:pylint file="build/pylint.out" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
482
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
483
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
484 XML Tools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
485 =========
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
486
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
487 A collection of recipe commands for XML processing.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
488
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
489 :Namespace: ``http://bitten.cmlenz.net/tools/xml``
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
490 :Common prefix: ``x``
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
491
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
492
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
493 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
494 ``<x:transform>``
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
495 -----------------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
496
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
497 Apply an XSLT stylesheet .
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
498
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
499 .. note:: that this command requires either libxslt_ (with `Python bindings`_)
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
500 or, on Windows platforms, MSXML (version 3 or later) to be installed
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
501 on the slave machine.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
502
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
503 .. _libxslt: http://xmlsoft.org/XSLT/
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
504 .. _`python bindings`: http://xmlsoft.org/XSLT/python.html
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
505
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
506 Parameters
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
507 ----------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
508
413
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
509 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
510 | Name | Description |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
511 +================+===========================================================+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
512 | ``src`` | Path of the source XML file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
513 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
514 | ``dest`` | Path of the destition XML file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
515 +----------------+-----------------------------------------------------------+
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
516 | ``stylesheet`` | Path to the XSLT stylesheet file. |
fa72698e7477 Don't put tables in blockquotes in command reference.
cmlenz
parents: 412
diff changeset
517 +----------------+-----------------------------------------------------------+
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
518
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
519 All these are interpreted relative to the project source directory.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
520
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
521 Examples
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
522 --------
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
523
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
524 .. code-block:: xml
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
525
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
526 <x:transform src="src.xml" dest="dest.xml" stylesheet="util/convert.xsl" />
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
527
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
528 This applies the stylesheet in ``util/convert.xsl`` to the source file
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
529 ``src.xml``, and writes the resulting XML document to ``dest.xml``.
Copyright (C) 2012-2017 Edgewall Software