ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/runtime.html
Revision: 1.1.2.1.6.1
Committed: Tue Oct 31 16:33:55 2000 UTC (24 years, 6 months ago) by williamc
Content type: text/html
Branch: V0_16branch
Changes since 1.1.2.1: +9 -2 lines
Log Message:
Add project runtime document description

File Contents

# User Rev Content
1 williamc 1.1.2.1 <! 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     </ul>
18     <hr>
19     <a name=QS>
20     <h1>Configuration Environment</h2></a>
21     Each development area has associated with it an environment which is related to
22 williamc 1.1.2.1.6.1 the tools specified in the configuration, and the environmental variables
23     specified in your Project Runtime Document. If you wish to set project wide
24     values create a document called <em>Runtime</em> in your project configuration
25     directory. The format of this document is identical to that for
26     <a href=#AS>Application Environments</a>
27    
28     <p>
29     The environment can seen
30 williamc 1.1.2.1 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 &lt;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    
76     <li><h2>Constructing a Runtime Environment File</h2>
77     An environmental variable in the runtime is indicated by
78     <p>
79     <font color=green>
80     &lt;Runtime name=<em>VARIABLE</em> value=<em>value1</em> [type=path]><br>
81     Descriptive text of the variable - provides help to the users!<br>
82     &lt/Runtime>
83     </font><p>
84     Groups are not yet supported by the runtime mechanism.
85     </ul>
86     <! Style Sheet Footer ---------------Do not change anything after this line-->
87     <hr>
88     <table border=1 width=100%>
89     <td align=left>
90     <a href=mailto:Christopher.Williams@cern.ch
91     >Chris Williams</a>
92     </td>
93     <td align=center>
94 williamc 1.1.2.1.6.1 Last Updated Tue Oct 31 17:29:35 2000
95 williamc 1.1.2.1 </td>
96     <td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
97     </td>
98     </table>
99     </body> </html>
100     <! End Style Sheet Footer>