12 |
|
<font color=red>M</font>anagement |
13 |
|
</center> |
14 |
|
<hr> |
15 |
+ |
The Tool Document is an <a href=ActiveDoc.html>ActiveDoc</a>.<br> |
16 |
|
Each configuration tool that is requested in the requirements document |
17 |
|
needs to be described to the SCRAM configuration manager. |
18 |
< |
This is done with an |
19 |
< |
SGML Description Document. |
19 |
< |
The document |
20 |
< |
will describe such things as the default location of the tool on the system, |
21 |
< |
names of libraries and environmental variables that need to be set. |
18 |
> |
The tool document will describe such things as the default location of the tool on the system, |
19 |
> |
names of libraries and environment variables that must be set. |
20 |
|
|
21 |
|
<h2>Tags</h2> |
22 |
|
<table border=1> |
23 |
|
<tr> |
24 |
|
<td> |
25 |
|
<font color=green> |
26 |
+ |
<doc type=BuildSystem::ToolDoc version=1.1><br> |
27 |
+ |
</font> |
28 |
+ |
</td> |
29 |
+ |
<td> |
30 |
+ |
Must be specified in any document to indicate how it should be parsed. |
31 |
+ |
</td> |
32 |
+ |
</tr> |
33 |
+ |
<tr> |
34 |
+ |
<td> |
35 |
+ |
<font color=green> |
36 |
|
<Tool name=<em>name</em> version=<em>version</em>><br> |
37 |
|
</Tool> |
38 |
|
</font> |
39 |
|
</td> |
40 |
|
<td> |
41 |
< |
Specify the name and the version of the tool that is being described |
42 |
< |
Everything between these tags relates to the specified tool |
41 |
> |
Specify the name and the version of the tool that is being described. |
42 |
> |
Everything between these tags relates to the specified tool. |
43 |
|
</td> |
44 |
|
</tr> |
45 |
|
<tr> |
53 |
|
</td> |
54 |
|
<td> |
55 |
|
Set up a variable in the scram environment for this tool. Anything between |
56 |
< |
these tags should describe the purpose of the Environmental variable. It is |
56 |
> |
these tags should describe the purpose of the environment variable. It is |
57 |
|
printed out as a guide to the user if SCRAM needs to ask for help in setting |
58 |
|
up the value of the variable. |
59 |
|
</td> |
65 |
|
</font> |
66 |
|
</td> |
67 |
|
<td> |
68 |
< |
Specify that the current tool has a dependency on another tool |
68 |
> |
Specify that the current tool has a dependency on another tool. |
69 |
|
</td> |
70 |
|
</tr> |
71 |
|
<tr> |
89 |
|
</font> |
90 |
|
</td> |
91 |
|
<td> |
92 |
< |
Specify the name of a library - you do not need the preceding lib or extension |
92 |
> |
Specify the name of a library - you do not need the preceding lib or extension. |
93 |
|
</td> |
94 |
|
</tr> |
95 |
|
<tr> |
96 |
|
<td> |
97 |
|
<font color=green> |
98 |
|
<Architecture name=<em>OSname</em>><br> |
99 |
< |
<Architecture> |
99 |
> |
</Architecture> |
100 |
|
</font> |
101 |
|
</td> |
102 |
|
<td> |
103 |
|
Anything between these tags will apply only to Architectures that match the |
104 |
< |
<em>OSname</em> |
104 |
> |
<em>OSname</em>. |
105 |
> |
</td> |
106 |
> |
</tr> |
107 |
> |
<tr> |
108 |
> |
<td> |
109 |
> |
<font color=green> |
110 |
> |
<Makefile></Makefile> |
111 |
> |
</font> |
112 |
> |
</td> |
113 |
> |
<td> |
114 |
> |
These tags delimit gmake file content intended for inclusion in the build |
115 |
> |
system associated with the tool. |
116 |
|
</td> |
117 |
|
</tr> |
118 |
|
</table> |
148 |
|
|
149 |
|
</pre> |
150 |
|
</font> |
151 |
+ |
|
152 |
|
The above file describes the Example project. Note that all defined enviornment |
153 |
|
variables can be referred to by others. In addition the SCRAM_ARCH, |
154 |
|
SCRAMtoolname, SCRAMtoolversion are also defined. |
155 |
+ |
<p> |
156 |
|
<! Style Sheet Footer ---------------Do not change anything after this line--> |
157 |
|
<hr> |
158 |
|
<table border=1 width=100%> |
159 |
|
<td align=left> |
160 |
< |
<a href=mailto:Christopher.Williams@cern.ch |
161 |
< |
>Chris Williams</a> |
160 |
> |
<a href=mailto:Shaun.Ashby@cern.ch |
161 |
> |
>Shaun Ashby</a> |
162 |
|
</td> |
163 |
|
<td align=center> |
164 |
< |
Last Updated Thu May 4 16:02:52 2000 |
164 |
> |
<SCRIPT LANGUAGE="JAVASCRIPT">document.write("Last Updated "+ document.lastModified );</SCRIPT> |
165 |
|
</td> |
166 |
|
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a> |
167 |
|
</td> |