| 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 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.
|
| 43 |
</td>
|
| 44 |
</tr>
|
| 45 |
<tr>
|
| 46 |
<td>
|
| 47 |
<font color=green>
|
| 48 |
<Environment name=<em>variablename</em> [type=lib|Runtime|Runtime_path]
|
| 49 |
[value=<em>value</em> | default=<em>trial_value</em>]>
|
| 50 |
<br>
|
| 51 |
</Environment>
|
| 52 |
</font>
|
| 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 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>
|
| 60 |
</tr>
|
| 61 |
<tr>
|
| 62 |
<td>
|
| 63 |
<font color=green>
|
| 64 |
<External ref=<em>name</em>>
|
| 65 |
</font>
|
| 66 |
</td>
|
| 67 |
<td>
|
| 68 |
Specify that the current tool has a dependency on another tool.
|
| 69 |
</td>
|
| 70 |
</tr>
|
| 71 |
<tr>
|
| 72 |
<td>
|
| 73 |
<font color=green>
|
| 74 |
<client><br>
|
| 75 |
</client>
|
| 76 |
</font>
|
| 77 |
</td>
|
| 78 |
<td>
|
| 79 |
Any <Environment> between these tags will be checked as a directory location
|
| 80 |
on the client machine. If the environment is of <em>type=lib</em> the presence
|
| 81 |
of all libraries defined by previous <lib> tags will also be checked for
|
| 82 |
in that directory.
|
| 83 |
</td>
|
| 84 |
</tr>
|
| 85 |
<tr>
|
| 86 |
<td>
|
| 87 |
<font color=green>
|
| 88 |
<lib name=<em>name</em>>
|
| 89 |
</font>
|
| 90 |
</td>
|
| 91 |
<td>
|
| 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>
|
| 100 |
</font>
|
| 101 |
</td>
|
| 102 |
<td>
|
| 103 |
Anything between these tags will apply only to Architectures that match the
|
| 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>
|
| 119 |
|
| 120 |
<h2>Example</h2>
|
| 121 |
<font color=green>
|
| 122 |
<pre>
|
| 123 |
<Tool name=Example version=V2_0_0>
|
| 124 |
|
| 125 |
<Client>
|
| 126 |
<lib name=lib1>
|
| 127 |
<lib name=lib2>
|
| 128 |
<Environment name=Example_BASE>
|
| 129 |
Example information available from
|
| 130 |
(http://cmsdoc.cern.ch/cmsoo/projects/Example/)
|
| 131 |
<br>The top directory of the Example distribution
|
| 132 |
</Environment>
|
| 133 |
|
| 134 |
<Environment name=LIBDIR default=$Example_BASE/$SCRAM_ARCH/lib type=lib>
|
| 135 |
The Example library directory
|
| 136 |
</Environment>
|
| 137 |
|
| 138 |
<Environment name=INCLUDE default="$Example_BASE/src">
|
| 139 |
The default Example include directory
|
| 140 |
Usually the path up to and including src
|
| 141 |
</Environment>
|
| 142 |
</Client>
|
| 143 |
|
| 144 |
<Environment name=LD_LIBRARY_PATH value=$LIBDIR type=Runtime_path>
|
| 145 |
</Environment>
|
| 146 |
<External ref=Qt>
|
| 147 |
</Tool>
|
| 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:Shaun.Ashby@cern.ch
|
| 161 |
>Shaun Ashby</a>
|
| 162 |
</td>
|
| 163 |
<td align=center>
|
| 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>
|
| 168 |
</table>
|
| 169 |
</body> </html>
|
| 170 |
<! End Style Sheet Footer>
|
