| 1 |
williamc |
1.2 |
<! Style Sheet Header>
|
| 2 |
|
|
<html>
|
| 3 |
|
|
<head>
|
| 4 |
|
|
<title>runtime.html</title>
|
| 5 |
|
|
<body bgcolor=beige>
|
| 6 |
|
|
<! End Style Sheet Header -----------Insert Text Here --------------------->
|
| 7 |
|
|
<center>
|
| 8 |
|
|
<H1>The Runtime Environment</H1>
|
| 9 |
|
|
<font color=red>S</font>oftware <font color=red>C</font>onfiguration,
|
| 10 |
|
|
<font color=red>R</font>elease <font color=red>A</font>nd
|
| 11 |
|
|
<font color=red>M</font>anagement
|
| 12 |
|
|
</center>
|
| 13 |
|
|
Contents<br>
|
| 14 |
|
|
<ul>
|
| 15 |
|
|
<li><a href=#QS>Configuration Environment</a>
|
| 16 |
|
|
<li><a href=#AS>Application Environments</a>
|
| 17 |
williamc |
1.3 |
<li><a href=#RD>Runtime Documents</a>
|
| 18 |
williamc |
1.2 |
</ul>
|
| 19 |
|
|
<hr>
|
| 20 |
|
|
<a name=QS>
|
| 21 |
|
|
<h1>Configuration Environment</h2></a>
|
| 22 |
|
|
Each development area has associated with it an environment which is related to
|
| 23 |
williamc |
1.3 |
the tools specified in the configuration, and the environmental variables
|
| 24 |
|
|
specified in your Project Runtime Document. If you wish to set project wide
|
| 25 |
|
|
values create a document called <em>Runtime</em> in your project configuration
|
| 26 |
|
|
directory. This document is a <a href=#RD>Runtime Document</a>
|
| 27 |
|
|
|
| 28 |
|
|
<p>
|
| 29 |
|
|
The environment can seen
|
| 30 |
williamc |
1.2 |
using the
|
| 31 |
|
|
<p>
|
| 32 |
|
|
<em>
|
| 33 |
|
|
scram runtime [-csh|-sh]
|
| 34 |
|
|
</em>
|
| 35 |
|
|
<p>
|
| 36 |
|
|
command. Running the command as is will print the commands to the standard
|
| 37 |
|
|
output in either the csh or sh flavours. Note that it will not actually
|
| 38 |
|
|
run the commands - just print them. See scram runtime help for some examples
|
| 39 |
|
|
of using this command.
|
| 40 |
|
|
<p>
|
| 41 |
|
|
All variables that are set also have an associated SCRAMRT_xxx variable. This
|
| 42 |
|
|
allows scram to undo changes to the environment. This allows you, for example,
|
| 43 |
|
|
to switch between project environments without the two interfering. This
|
| 44 |
|
|
consistency checking is done automatically.
|
| 45 |
|
|
|
| 46 |
|
|
<a name=AS>
|
| 47 |
|
|
<h1>Application Environments</h1>
|
| 48 |
|
|
<ul>
|
| 49 |
|
|
An application may have environmental requirements in addition to the general
|
| 50 |
|
|
configuration described above. The runtime mechanism supports
|
| 51 |
|
|
this through the use of the <Runtime> tag.
|
| 52 |
|
|
<p>
|
| 53 |
|
|
Note that this means the Configuration Environment descriped above needs to
|
| 54 |
|
|
be set in addition.
|
| 55 |
|
|
<li><h2>Setting an application environment</h2>
|
| 56 |
|
|
<pre>
|
| 57 |
|
|
scram runtime [-csh|-sh] runtimefile
|
| 58 |
|
|
</pre>
|
| 59 |
|
|
The file runtimefile is searched for in the following order :
|
| 60 |
|
|
<ol>
|
| 61 |
|
|
<li>filename relative to current directory
|
| 62 |
|
|
<li>filename relative to local_area/src
|
| 63 |
|
|
<li>filename relative to release_area/src
|
| 64 |
|
|
<li>location of a BuildFile relative to local_area/src
|
| 65 |
|
|
<li>location of a BuildFile relative to release_area/src
|
| 66 |
|
|
</ol>
|
| 67 |
|
|
<li><h2>Information on Runtime Variables</h2>
|
| 68 |
|
|
<p>
|
| 69 |
|
|
<em>
|
| 70 |
|
|
scram runtime info runtimefile [variable]
|
| 71 |
|
|
</em>
|
| 72 |
|
|
<p>
|
| 73 |
|
|
Will print out any help available to describe the variables in the file
|
| 74 |
|
|
The optional variable will restrict the output to the specified variable.
|
| 75 |
williamc |
1.3 |
</ul>
|
| 76 |
williamc |
1.2 |
|
| 77 |
williamc |
1.3 |
<a name=RD>
|
| 78 |
|
|
<h1>Constructing Runtime Environment Documents</h1>
|
| 79 |
williamc |
1.2 |
An environmental variable in the runtime is indicated by
|
| 80 |
|
|
<p>
|
| 81 |
|
|
<font color=green>
|
| 82 |
|
|
<Runtime name=<em>VARIABLE</em> value=<em>value1</em> [type=path]><br>
|
| 83 |
|
|
Descriptive text of the variable - provides help to the users!<br>
|
| 84 |
|
|
</Runtime>
|
| 85 |
|
|
</font><p>
|
| 86 |
|
|
Groups are not yet supported by the runtime mechanism.
|
| 87 |
|
|
<! Style Sheet Footer ---------------Do not change anything after this line-->
|
| 88 |
|
|
<hr>
|
| 89 |
|
|
<table border=1 width=100%>
|
| 90 |
|
|
<td align=left>
|
| 91 |
sashby |
1.4 |
<a href=mailto:Shaun.Ashby@cern.ch
|
| 92 |
|
|
>Shaun Ashby</a>
|
| 93 |
williamc |
1.2 |
</td>
|
| 94 |
|
|
<td align=center>
|
| 95 |
sashby |
1.4 |
<SCRIPT LANGUAGE="JAVASCRIPT">document.write("Last Updated "+ document.lastModified );</SCRIPT>
|
| 96 |
williamc |
1.2 |
</td>
|
| 97 |
|
|
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
|
| 98 |
|
|
</td>
|
| 99 |
|
|
</table>
|
| 100 |
|
|
</body> </html>
|
| 101 |
|
|
<! End Style Sheet Footer>
|
