ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/bootstrap.html
Revision: 1.2
Committed: Mon Aug 28 08:40:55 2000 UTC (24 years, 8 months ago) by williamc
Content type: text/html
Branch: MAIN
Changes since 1.1: +111 -0 lines
Log Message:
Merge in new documentation

File Contents

# Content
1 <! Style Sheet Header>
2 <html>
3 <head>
4 <title>bootstrap.html</title>
5 <body bgcolor=beige>
6 <! End Style Sheet Header -----------Insert Text Here --------------------->
7 <center>
8 <h2>The BootStrap File (Version 1.0)</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 BootStrapFile is an <a href=ActiveDoc.html>ActiveDoc</a>
16 (without the &lt;Include> tags)<br>
17 The function of the bootstrap document is to define the name and version
18 of a project and to tell scram from where it can download the projects
19 configuration and source code files and where to put them inside the
20 release area.
21 <p>
22 <h2>Tags</h2>
23 <table border=1>
24 <tr>
25 <td>
26 <font color=green>
27 &lt;doc type=Configuration::BootStrapProject version=1.0>
28 </font>
29 </td>
30 <td>
31 Specify the Document type and version to enable correct parsing
32 </td>
33 </tr>
34 <tr>
35 <td>
36 <font color=green>
37 &lt;Project name=<em>name</em> version=<em>version</em>><br>
38 &lt;/Project>
39 </font>
40 </td>
41 <td>
42 Specify the name and version of the project
43 </td>
44 </tr>
45 <tr>
46 <td>
47 <font color=green>
48 &lt;Download url=<em>url</em> name=<em>location</em>>
49 </font>
50 </td>
51 <td>
52 Download the specified URL. If the <em>name</em> is specified then the
53 url will be downloaded to a directory (relative to the projects top directory)
54 with the given name. URL is merged with the <a href=ActiveDoc.html>&lt;Base>
55 tags.
56 </td>
57 </tr>
58 <tr>
59 <td>
60 <font color=green>
61 &lt;config dir=<em>dir</em>>
62 </font>
63 </td>
64 <td>
65 Specify the name of the directory (relative to the top of the project area)
66 from where to pick up the project configuration files
67 </td>
68 </tr>
69 <tr>
70 <td>
71 <font color=green>
72 &lt;Requirements name=<em>Doc_name</em>>
73 </font>
74 </td>
75 <td>
76 Specify the name of the requirements document (relative to the top of the
77 project area)
78 </td>
79 </tr>
80 </table>
81 <h2>Example</h2>
82 <font color=green>
83 <pre>
84 &lt;doc type=Configuration::BootStrapProject version=1.0>
85 &lt;project name=ORCA version=test>
86 ORCA Test BootStrap
87 &lt;Config dir=config>
88 &lt;base url="cvs://cmscvs.cern.ch/cvs_server/repositories/ORCA?auth=pserver&user=anonymous&passkey=AA_:yZZ3e?version=ORCA_4_3_0_pre3">
89 &lt;download url="cvs:?module=config&version=TEST" name="config">
90 &lt;download url="cvs:?module=ORCA/Utilities" name="src/Utilities">
91 &lt;download url="cvs:?module=ORCA/Porting" name="src/Porting">
92 &lt;RequirementsDoc name=config/RequirementsDoc>
93 &lt;/base>
94 &lt;/project>
95 </pre>
96 </font>
97 <! Style Sheet Footer ---------------Do not change anything after this line-->
98 <hr>
99 <table border=1 width=100%>
100 <td align=left>
101 <a href=mailto:Christopher.Williams@cern.ch
102 >Chris Williams</a>
103 </td>
104 <td align=center>
105 Last Updated Tue Aug 15 13:55:29 2000
106 </td>
107 <td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
108 </td>
109 </table>
110 </body> </html>
111 <! End Style Sheet Footer>