/[eiffelstudio]/vendor/gobosoft.com/gobo/current/doc/geant/geant_task.xml
ViewVC logotype

Contents of /vendor/gobosoft.com/gobo/current/doc/geant/geant_task.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 90767 - (show annotations)
Tue Jan 22 00:56:30 2013 UTC (6 years, 8 months ago) by manus
File MIME type: text/xml
File size: 7581 byte(s)
Updated svn:eol-style to be native and svn:mime-style to be text/xml

1 <?xml version="1.0"?>
2
3 <!--
4 description:
5
6 "Geant Tasks"
7
8 library: "Gobo Eiffel Ant"
9 copyright: "Copyright (c) 2002, Sven Ehrke and others"
10 license: "MIT License"
11 date: "$Date$"
12 revision: "$Revision$"
13 -->
14
15 <chapter xmlns="http://www.gobosoft.com/eiffel/gobo/documentation" id="geant_task">
16 <chapterinfo>
17 <copyright>
18 <year>2002-2005</year>
19 <holder>Sven Ehrke</holder>
20 </copyright>
21 <author>
22 <firstname>Sven</firstname><surname>Ehrke</surname>
23 </author>
24 <email>ericb@gobosoft.com</email>
25 <date>7 July 2005</date>
26 </chapterinfo>
27
28 <title>geant</title>
29
30 <section id="geant_description">
31 <title>Description</title>
32 <para>
33 Sometimes when projects get large it is useful to make build scripts more
34 modular. It would be useful for example to call subtargets in a procedural manner
35 and it would be useful to use more than one build script since the build script usually
36 grows with the size of the project. With the geant task you can accomplish this.
37 </para>
38 </section>
39
40 <section id="geant_parameters">
41 <title>Parameters</title>
42
43 <variablelist>
44 <varlistentry>
45 <term>arguments</term>
46 <listitem>
47 <para><emphasis>Description: </emphasis>Comma separated list of values to be passed
48 as arguments to the target to be called. The number of values must match the number of
49 formal arguments of that target. The sequence is important: the first value
50 will be used for the first actual parameter, the second as the second and so on. This is
51 the so called terse way of argument passing.
52 </para>
53 </listitem>
54 <listitem>
55 <para><emphasis>Domain: </emphasis>Comma separated list of values</para>
56 </listitem>
57 <listitem>
58 <para><emphasis>Default: </emphasis>-</para>
59 </listitem>
60 </varlistentry>
61
62 <varlistentry>
63 <term>fork</term>
64 <listitem>
65 <para>
66 <emphasis>Description: </emphasis>Should a new operation system process be spawned for call?
67 <para>
68 When not specified the following default behavior applies:
69 If parameter 'file' has been specified the default value for 'fork' is 'true'.
70 If no parameter 'file' has been specified the default value for 'fork' is 'false',
71 </para>
72 </para>
73 </listitem>
74 <listitem>
75 <para><emphasis>Domain: </emphasis>true|false</para>
76 </listitem>
77 <listitem>
78 <para><emphasis>Default: </emphasis>see description</para>
79 </listitem>
80 </varlistentry>
81
82 <varlistentry>
83 <term>file</term>
84 <listitem>
85 <para><emphasis>Description: </emphasis>Name of build file to invoke</para>
86 </listitem>
87 <listitem>
88 <para><emphasis>Domain: </emphasis>Name of existing file</para>
89 </listitem>
90 <listitem>
91 <para><emphasis>Default: </emphasis>-</para>
92 </listitem>
93 </varlistentry>
94
95 <varlistentry>
96 <term>target</term>
97 <listitem>
98 <para>
99 <emphasis>Description: </emphasis>Name of target to invoke in current build file
100 respectively in buildfile specified through attribute <emphasis>file</emphasis>
101 if provided.
102 </para>
103 </listitem>
104 <listitem>
105 <para><emphasis>Domain: </emphasis>existing target</para>
106 </listitem>
107 <listitem>
108 <para><emphasis>Default: </emphasis>-</para>
109 </listitem>
110 </varlistentry>
111
112 <varlistentry>
113 <term>exit_code_variable</term>
114 <listitem>
115 <para><emphasis>Description: </emphasis>Name of variable holding the execution's return code
116 <!-- TODO: check if filesets are supported at all:
117 Note: This attribute can only be used when no fileset is used as nested argument
118 -->
119 </para>
120 </listitem>
121 <listitem>
122 <para><emphasis>Domain: </emphasis>Integer (usually 0 for OK, and any other number for not OK)</para>
123 </listitem>
124 <listitem>
125 <para><emphasis>Default: </emphasis>`Void' (no variable is set if attribute is not specified)</para>
126 </listitem>
127 </varlistentry>
128
129 <varlistentry>
130 <term>reuse_variables</term>
131 <listitem>
132 <para>
133 <emphasis>Description: </emphasis>Should variables defined in current build file
134 be available in invoked build file?
135 Note: This attribute is only evaluated if attribute <emphasis>file</emphasis>
136 if provided.
137 </para>
138 </listitem>
139 <listitem>
140 <para><emphasis>Domain: </emphasis>true|false</para>
141 </listitem>
142 <listitem>
143 <para><emphasis>Default: </emphasis>false</para>
144 </listitem>
145 </varlistentry>
146 </variablelist>
147 </section>
148
149 <section id="geant_nested_parameters">
150 <title>Parameters specified as nested elements</title>
151
152 <variablelist>
153 <varlistentry>
154 <term>argument</term>
155 <listitem>
156 <para><emphasis>Description: </emphasis>Element representing a actual argument
157 for the target to be called. The name of the matching formal argument is specified
158 by the attribute 'name'. The value to be used is specified through the attribute 'value'.
159 The names of the arguments and the number of arguments must match the formal ones of
160 the target to be called.
161 </para>
162 </listitem>
163 <listitem>
164 <para><emphasis>Domain: </emphasis>-</para>
165 </listitem>
166 <listitem>
167 <para><emphasis>Default: </emphasis>-</para>
168 </listitem>
169 </varlistentry>
170 </variablelist>
171 </section>
172
173
174 <section id="geant_specification">
175 <title>RNG Specification</title>
176
177 <programlisting><![CDATA[
178 <define name="geant">
179 <element name="geant">
180 <ref name="dir_if_unless"/>
181 <optional>
182 <choice>
183 <attribute name="arguments"/>
184 <zeroOrMore>
185 <element name="argument">
186 <attribute name="name"/>
187 <attribute name="value"/>
188 </element>
189 </zeroOrMore>
190 </choice>
191 </optional>
192 <optional>
193 <attribute name="fork">
194 <!-- runtime evaluation
195 <choice>
196 <value>true</value>
197 <value>false</value>
198 </choice>
199 -->
200 </attribute>
201 </optional>
202 <optional>
203 <attribute name="exit_code_variable"/>
204 </optional>
205 <choice>
206 <attribute name="target"/>
207 <group>
208 <attribute name="file"/>
209 <optional>
210 <attribute name="reuse_variables">
211 <!-- runtime evaluation
212 <choice>
213 <value>true</value>
214 <value>false</value>
215 </choice>
216 -->
217 </attribute>
218 </optional>
219 <optional>
220 <ref name="fileset"/>
221 </optional>
222 </group>
223 <group>
224 <attribute name="file"/>
225 <attribute name="target"/>
226 <optional>
227 <attribute name="reuse_variables">
228 <!-- runtime evaluation
229 <choice>
230 <value>true</value>
231 <value>false</value>
232 </choice>
233 -->
234 </attribute>
235 </optional>
236 <optional>
237 <ref name="fileset"/>
238 </optional>
239 </group>
240 <ref name="fileset"/>
241 </choice>
242 </element>
243 </define>
244 ]]>
245 </programlisting>
246 </section>
247
248 <section id="geant_examples">
249 <title>Examples</title>
250
251 <programlisting><![CDATA[
252 <geant file="build2.eant"/>
253
254 <geant file="build2.eant" target="compile"/>
255
256 <geant file="build2.eant" target="compile" reuse_variables="true"/>
257
258 <geant target="compile"/>
259 ]]>
260 </programlisting>
261 </section>
262
263
264 </chapter>

Properties

Name Value
svn:mime-type text/xml

  ViewVC Help
Powered by ViewVC 1.1.23