ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/configurationtools.html
Revision: 1.6
Committed: Mon Nov 18 11:31:38 2002 UTC (22 years, 5 months ago) by sashby
Content type: text/html
Branch: MAIN
CVS Tags: V1_pre0, HEAD
Branch point for: SCRAM_V1_BRANCH
Changes since 1.5: +0 -0 lines
State: FILE REMOVED
Log Message: 
Removed old documentation.

File Contents

# User Rev Content
1 williamc 1.2 <! 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 sashby 1.5 The Tool Document is an <a href=ActiveDoc.html>ActiveDoc</a>.<br>
16 williamc 1.2 Each configuration tool that is requested in the requirements document
17     needs to be described to the SCRAM configuration manager.
18 sashby 1.5 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 williamc 1.2
21     <h2>Tags</h2>
22     <table border=1>
23     <tr>
24     <td>
25     <font color=green>
26 williamc 1.3 &lt;doc type=BuildSystem::ToolDoc version=1.1><br>
27 williamc 1.2 </font>
28     </td>
29     <td>
30 sashby 1.5 Must be specified in any document to indicate how it should be parsed.
31 williamc 1.2 </td>
32     </tr>
33     <tr>
34     <td>
35     <font color=green>
36     &lt;Tool name=<em>name</em> version=<em>version</em>><br>
37     &lt;/Tool>
38     </font>
39     </td>
40     <td>
41 sashby 1.5 Specify the name and the version of the tool that is being described.
42     Everything between these tags relates to the specified tool.
43 williamc 1.2 </td>
44     </tr>
45     <tr>
46     <td>
47     <font color=green>
48     &lt;Environment name=<em>variablename</em> [type=lib|Runtime|Runtime_path]
49     [value=<em>value</em> | default=<em>trial_value</em>]>
50     <br>
51     &lt;/Environment>
52     </font>
53     </td>
54     <td>
55     Set up a variable in the scram environment for this tool. Anything between
56 sashby 1.5 these tags should describe the purpose of the environment variable. It is
57 williamc 1.2 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     &lt;External ref=<em>name</em>>
65     </font>
66     </td>
67     <td>
68 sashby 1.5 Specify that the current tool has a dependency on another tool.
69 williamc 1.2 </td>
70     </tr>
71     <tr>
72     <td>
73     <font color=green>
74     &lt;client><br>
75     &lt;/client>
76     </font>
77     </td>
78     <td>
79     Any &lt;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 &lt;lib> tags will also be checked for
82     in that directory.
83     </td>
84     </tr>
85     <tr>
86     <td>
87     <font color=green>
88     &lt;lib name=<em>name</em>>
89     </font>
90     </td>
91     <td>
92 sashby 1.5 Specify the name of a library - you do not need the preceding lib or extension.
93 williamc 1.2 </td>
94     </tr>
95     <tr>
96     <td>
97     <font color=green>
98     &lt;Architecture name=<em>OSname</em>><br>
99 williamc 1.3 &lt;/Architecture>
100 williamc 1.2 </font>
101     </td>
102     <td>
103     Anything between these tags will apply only to Architectures that match the
104 sashby 1.5 <em>OSname</em>.
105 williamc 1.3 </td>
106     </tr>
107     <tr>
108     <td>
109     <font color=green>
110     &lt;Makefile>&lt;/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 williamc 1.2 </td>
117     </tr>
118     </table>
119    
120     <h2>Example</h2>
121     <font color=green>
122     <pre>
123     &lt;Tool name=Example version=V2_0_0>
124    
125     &lt;Client>
126     <lib name=lib1>
127     <lib name=lib2>
128     &lt;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     &lt;/Environment>
133    
134     &lt;Environment name=LIBDIR default=$Example_BASE/$SCRAM_ARCH/lib type=lib>
135     The Example library directory
136     &lt;/Environment>
137    
138     &lt;Environment name=INCLUDE default="$Example_BASE/src">
139     The default Example include directory
140     Usually the path up to and including src
141     &lt;/Environment>
142     &lt;/Client>
143    
144     &lt;Environment name=LD_LIBRARY_PATH value=$LIBDIR type=Runtime_path>
145     &lt;/Environment>
146     &lt;External ref=Qt>
147     &lt;/Tool>
148    
149     </pre>
150     </font>
151 sashby 1.5
152 williamc 1.2 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 sashby 1.5 <p>
156 williamc 1.2 <! Style Sheet Footer ---------------Do not change anything after this line-->
157     <hr>
158     <table border=1 width=100%>
159     <td align=left>
160 sashby 1.4 <a href=mailto:Shaun.Ashby@cern.ch
161     >Shaun Ashby</a>
162 williamc 1.2 </td>
163     <td align=center>
164 sashby 1.4 <SCRIPT LANGUAGE="JAVASCRIPT">document.write("Last Updated "+ document.lastModified );</SCRIPT>
165 williamc 1.2 </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>