| 1 |
+ |
<! Style Sheet Header> |
| 2 |
+ |
<html> |
| 3 |
+ |
<head> |
| 4 |
+ |
<title>configurationtools.html</title> |
| 5 |
+ |
<body bgcolor=beige> |
| 6 |
+ |
<! End Style Sheet Header -----------Insert Text Here ---------------------> |
| 7 |
+ |
<center> |
| 8 |
+ |
<h2>Describing External Tools To The Configuration Manager</h2> |
| 9 |
+ |
<p> |
| 10 |
+ |
<font color=red>S</font>oftware <font color=red>C</font>onfiguration, |
| 11 |
+ |
<font color=red>R</font>elease <font color=red>A</font>nd |
| 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 |
+ |
The tool document |
| 19 |
+ |
will describe such things as the default location of the tool on the system, |
| 20 |
+ |
names of libraries and environmental variables that need to be set. |
| 21 |
+ |
|
| 22 |
+ |
<h2>Tags</h2> |
| 23 |
+ |
<table border=1> |
| 24 |
+ |
<tr> |
| 25 |
+ |
<td> |
| 26 |
+ |
<font color=green> |
| 27 |
+ |
<doc type=BuildSystem::ToolDoc version=1.0><br> |
| 28 |
+ |
</font> |
| 29 |
+ |
</td> |
| 30 |
+ |
<td> |
| 31 |
+ |
Must be specified included in any document to indicate how to parse |
| 32 |
+ |
</td> |
| 33 |
+ |
</tr> |
| 34 |
+ |
<tr> |
| 35 |
+ |
<td> |
| 36 |
+ |
<font color=green> |
| 37 |
+ |
<Tool name=<em>name</em> version=<em>version</em>><br> |
| 38 |
+ |
</Tool> |
| 39 |
+ |
</font> |
| 40 |
+ |
</td> |
| 41 |
+ |
<td> |
| 42 |
+ |
Specify the name and the version of the tool that is being described |
| 43 |
+ |
Everything between these tags relates to the specified tool |
| 44 |
+ |
</td> |
| 45 |
+ |
</tr> |
| 46 |
+ |
<tr> |
| 47 |
+ |
<td> |
| 48 |
+ |
<font color=green> |
| 49 |
+ |
<Environment name=<em>variablename</em> [type=lib|Runtime|Runtime_path] |
| 50 |
+ |
[value=<em>value</em> | default=<em>trial_value</em>]> |
| 51 |
+ |
<br> |
| 52 |
+ |
</Environment> |
| 53 |
+ |
</font> |
| 54 |
+ |
</td> |
| 55 |
+ |
<td> |
| 56 |
+ |
Set up a variable in the scram environment for this tool. Anything between |
| 57 |
+ |
these tags should describe the purpose of the Environmental variable. It is |
| 58 |
+ |
printed out as a guide to the user if SCRAM needs to ask for help in setting |
| 59 |
+ |
up the value of the variable. |
| 60 |
+ |
</td> |
| 61 |
+ |
</tr> |
| 62 |
+ |
<tr> |
| 63 |
+ |
<td> |
| 64 |
+ |
<font color=green> |
| 65 |
+ |
<External ref=<em>name</em>> |
| 66 |
+ |
</font> |
| 67 |
+ |
</td> |
| 68 |
+ |
<td> |
| 69 |
+ |
Specify that the current tool has a dependency on another tool |
| 70 |
+ |
</td> |
| 71 |
+ |
</tr> |
| 72 |
+ |
<tr> |
| 73 |
+ |
<td> |
| 74 |
+ |
<font color=green> |
| 75 |
+ |
<client><br> |
| 76 |
+ |
</client> |
| 77 |
+ |
</font> |
| 78 |
+ |
</td> |
| 79 |
+ |
<td> |
| 80 |
+ |
Any <Environment> between these tags will be checked as a directory location |
| 81 |
+ |
on the client machine. If the environment is of <em>type=lib</em> the presence |
| 82 |
+ |
of all libraries defined by previous <lib> tags will also be checked for |
| 83 |
+ |
in that directory. |
| 84 |
+ |
</td> |
| 85 |
+ |
</tr> |
| 86 |
+ |
<tr> |
| 87 |
+ |
<td> |
| 88 |
+ |
<font color=green> |
| 89 |
+ |
<lib name=<em>name</em>> |
| 90 |
+ |
</font> |
| 91 |
+ |
</td> |
| 92 |
+ |
<td> |
| 93 |
+ |
Specify the name of a library - you do not need the preceding lib or extension |
| 94 |
+ |
</td> |
| 95 |
+ |
</tr> |
| 96 |
+ |
<tr> |
| 97 |
+ |
<td> |
| 98 |
+ |
<font color=green> |
| 99 |
+ |
<Architecture name=<em>OSname</em>><br> |
| 100 |
+ |
<Architecture> |
| 101 |
+ |
</font> |
| 102 |
+ |
</td> |
| 103 |
+ |
<td> |
| 104 |
+ |
Anything between these tags will apply only to Architectures that match the |
| 105 |
+ |
<em>OSname</em> |
| 106 |
+ |
</td> |
| 107 |
+ |
</tr> |
| 108 |
+ |
</table> |
| 109 |
+ |
|
| 110 |
+ |
<h2>Example</h2> |
| 111 |
+ |
<font color=green> |
| 112 |
+ |
<pre> |
| 113 |
+ |
<Tool name=Example version=V2_0_0> |
| 114 |
+ |
|
| 115 |
+ |
<Client> |
| 116 |
+ |
<lib name=lib1> |
| 117 |
+ |
<lib name=lib2> |
| 118 |
+ |
<Environment name=Example_BASE> |
| 119 |
+ |
Example information available from |
| 120 |
+ |
(http://cmsdoc.cern.ch/cmsoo/projects/Example/) |
| 121 |
+ |
<br>The top directory of the Example distribution |
| 122 |
+ |
</Environment> |
| 123 |
+ |
|
| 124 |
+ |
<Environment name=LIBDIR default=$Example_BASE/$SCRAM_ARCH/lib type=lib> |
| 125 |
+ |
The Example library directory |
| 126 |
+ |
</Environment> |
| 127 |
+ |
|
| 128 |
+ |
<Environment name=INCLUDE default="$Example_BASE/src"> |
| 129 |
+ |
The default Example include directory |
| 130 |
+ |
Usually the path up to and including src |
| 131 |
+ |
</Environment> |
| 132 |
+ |
</Client> |
| 133 |
+ |
|
| 134 |
+ |
<Environment name=LD_LIBRARY_PATH value=$LIBDIR type=Runtime_path> |
| 135 |
+ |
</Environment> |
| 136 |
+ |
<External ref=Qt> |
| 137 |
+ |
</Tool> |
| 138 |
+ |
|
| 139 |
+ |
</pre> |
| 140 |
+ |
</font> |
| 141 |
+ |
The above file describes the Example project. Note that all defined enviornment |
| 142 |
+ |
variables can be referred to by others. In addition the SCRAM_ARCH, |
| 143 |
+ |
SCRAMtoolname, SCRAMtoolversion are also defined. |
| 144 |
+ |
<! Style Sheet Footer ---------------Do not change anything after this line--> |
| 145 |
+ |
<hr> |
| 146 |
+ |
<table border=1 width=100%> |
| 147 |
+ |
<td align=left> |
| 148 |
+ |
<a href=mailto:Christopher.Williams@cern.ch |
| 149 |
+ |
>Chris Williams</a> |
| 150 |
+ |
</td> |
| 151 |
+ |
<td align=center> |
| 152 |
+ |
Last Updated Thu May 4 16:02:52 2000 |
| 153 |
+ |
</td> |
| 154 |
+ |
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a> |
| 155 |
+ |
</td> |
| 156 |
+ |
</table> |
| 157 |
+ |
</body> </html> |
| 158 |
+ |
<! End Style Sheet Footer> |
