ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/runtime.html
Revision: 1.1.2.1
Committed: Fri Mar 31 10:16:37 2000 UTC (25 years, 1 month ago) by williamc
Content type: text/html
Branch: V0_9branch
CVS Tags: V0_16_4, V0_16_3, V0_16_2, V0_16_1, V0_16_0, V0_15_1, V0_15_0, V0_15_0beta, V0_14_0, V0_12_12_4, V0_12_12_3, V0_13_3, V0_13_2, V0_12_12_2, V0_12_12_1, V0_12_12_0, PlayGround_0, V0_13_1, V0_12_12, V0_13_0, V0_12_11, V0_12_9b, V0_12_10, V0_12_9, V0_12_8, V0_12_7, V0_12_6, V0_12_5, V0_12_4, V0_12_3, V0_12_2, V0_12_1, V0_12_0, V0_11_4, V0_11_3, V0_11_2, V0_11_1, V0_11_0, V0_10_19
Branch point for: V0_16branch, V0_15branch, HPWbranch
Changes since 1.1: +93 -0 lines
Log Message:
Basic runtime documentation

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     the requirments of the configuration. The required environmnet can seen
23     using the
24     <p>
25     <em>
26     scram runtime [-csh|-sh]
27     </em>
28     <p>
29     command. Running the command as is will print the commands to the standard
30     output in either the csh or sh flavours. Note that it will not actually
31     run the commands - just print them. See scram runtime help for some examples
32     of using this command.
33     <p>
34     All variables that are set also have an associated SCRAMRT_xxx variable. This
35     allows scram to undo changes to the environment. This allows you, for example,
36     to switch between project environments without the two interfering. This
37     consistency checking is done automatically.
38    
39     <a name=AS>
40     <h1>Application Environments</h1>
41     <ul>
42     An application may have environmental requirements in addition to the general
43     configuration described above. The runtime mechanism supports
44     this through the use of the &lt;Runtime> tag.
45     <p>
46     Note that this means the Configuration Environment descriped above needs to
47     be set in addition.
48     <li><h2>Setting an application environment</h2>
49     <pre>
50     scram runtime [-csh|-sh] runtimefile
51     </pre>
52     The file runtimefile is searched for in the following order :
53     <ol>
54     <li>filename relative to current directory
55     <li>filename relative to local_area/src
56     <li>filename relative to release_area/src
57     <li>location of a BuildFile relative to local_area/src
58     <li>location of a BuildFile relative to release_area/src
59     </ol>
60     <li><h2>Information on Runtime Variables</h2>
61     <p>
62     <em>
63     scram runtime info runtimefile [variable]
64     </em>
65     <p>
66     Will print out any help available to describe the variables in the file
67     The optional variable will restrict the output to the specified variable.
68    
69     <li><h2>Constructing a Runtime Environment File</h2>
70     An environmental variable in the runtime is indicated by
71     <p>
72     <font color=green>
73     &lt;Runtime name=<em>VARIABLE</em> value=<em>value1</em> [type=path]><br>
74     Descriptive text of the variable - provides help to the users!<br>
75     &lt/Runtime>
76     </font><p>
77     Groups are not yet supported by the runtime mechanism.
78     </ul>
79     <! Style Sheet Footer ---------------Do not change anything after this line-->
80     <hr>
81     <table border=1 width=100%>
82     <td align=left>
83     <a href=mailto:Christopher.Williams@cern.ch
84     >Chris Williams</a>
85     </td>
86     <td align=center>
87     Last Updated Fri Mar 31 11:25:13 2000
88     </td>
89     <td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
90     </td>
91     </table>
92     </body> </html>
93     <! End Style Sheet Footer>