| 5 |
|
<body bgcolor=beige> |
| 6 |
|
<! End Style Sheet Header -----------Insert Text Here ---------------------> |
| 7 |
|
<center> |
| 8 |
< |
<h2>The BootStrap File</h2> |
| 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 |
< |
<h2>Function</h2> |
| 15 |
> |
The BootStrapFile is an <a href=ActiveDoc.html>ActiveDoc</a> |
| 16 |
> |
(without the <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 how it can download the projects configuration |
| 19 |
< |
and source code files and where to put them. |
| 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 |
< |
<Project name=<em>name</em> version=<em>version</em>><br> |
| 26 |
< |
</Tool> |
| 27 |
> |
<doc type=Configuration::BootStrapProject version=1.0> |
| 28 |
|
</font> |
| 29 |
|
</td> |
| 30 |
|
<td> |
| 31 |
< |
Specify the name and version of the project |
| 31 |
> |
Specify the Document type and version to enable correct parsing. |
| 32 |
|
</td> |
| 33 |
|
</tr> |
| 34 |
|
<tr> |
| 35 |
|
<td> |
| 36 |
|
<font color=green> |
| 37 |
< |
<config dir=<em>dir</em>> |
| 37 |
> |
<Project name=<em>name</em> version=<em>version</em>><br> |
| 38 |
> |
</Project> |
| 39 |
|
</font> |
| 40 |
|
</td> |
| 41 |
|
<td> |
| 42 |
< |
Specify the name of the directory (relative to the top of the project area) |
| 41 |
< |
from where to pick up the project configuration files |
| 42 |
> |
Specify the name and version of the project. |
| 43 |
|
</td> |
| 44 |
|
</tr> |
| 45 |
|
<tr> |
| 46 |
|
<td> |
| 47 |
|
<font color=green> |
| 48 |
< |
<Requirements name=<em>Doc_name</em>> |
| 48 |
> |
<Download url=<em>url</em> name=<em>location</em>> |
| 49 |
|
</font> |
| 50 |
|
</td> |
| 51 |
|
<td> |
| 52 |
< |
Specify the name of the requirements document (in the configuration directory) |
| 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><Base> |
| 55 |
> |
tags. |
| 56 |
|
</td> |
| 57 |
|
</tr> |
| 58 |
|
<tr> |
| 59 |
|
<td> |
| 60 |
|
<font color=green> |
| 61 |
< |
<cvs fn=<em>cvs_function</em>> |
| 61 |
> |
<config dir=<em>dir</em>> |
| 62 |
|
</font> |
| 63 |
|
</td> |
| 64 |
|
<td> |
| 65 |
< |
Perform a cvs command |
| 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 |
< |
<cvsrep auth=[""|"pserver"|"kserver"|"ext"] [passkey=<em>key</em>] |
| 68 |
< |
[user=<em>username</em>] base=<em>cvsserver:repository</em>> |
| 69 |
< |
<br> |
| 70 |
< |
</cvsrep> |
| 72 |
> |
<RequirementsDoc name=<em>Doc_name</em>> |
| 73 |
|
</font> |
| 74 |
|
</td> |
| 75 |
|
<td> |
| 76 |
< |
Specify the cvs repository and authentication method for any <cvs> tags |
| 77 |
< |
inserted between the open and closing tags |
| 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 |
+ |
<doc type=Configuration::BootStrapProject version=1.0> |
| 85 |
+ |
<project name=ExampleProject version=V1_0> |
| 86 |
+ |
ORCA Test BootStrap |
| 87 |
+ |
<Config dir=config> |
| 88 |
+ |
<base url="cvs://cmscvs.cern.ch/cvs_server/repositories/ORCA?auth=pserver&user=anonymous&passkey=AA_:yZZ3e?version=ORCA_4_3_0_pre3"> |
| 89 |
+ |
<download url="cvs:?module=config&version=TEST" name="config"> |
| 90 |
+ |
<download url="cvs:?module=ORCA/Utilities" name="src/Utilities"> |
| 91 |
+ |
<download url="cvs:?module=ORCA/Porting" name="src/Porting"> |
| 92 |
+ |
<RequirementsDoc name=config/RequirementsDoc> |
| 93 |
+ |
</base> |
| 94 |
+ |
</project> |
| 95 |
+ |
</pre> |
| 96 |
+ |
</font> |
| 97 |
+ |
This BootStrapFile will cause scram to create a |
| 98 |
+ |
<a href=configarea.html>Project Area</a> called <em>ExampleProject_V1_0</em>. |
| 99 |
+ |
Inside this area it will create directories<br> |
| 100 |
+ |
<em>config<br>src/Utilities<br> |
| 101 |
+ |
src/Porting</em> |
| 102 |
+ |
<br>in which it will download the appropriate files from |
| 103 |
+ |
the specified cvs server. |
| 104 |
+ |
<br> |
| 105 |
+ |
Note how the url for the cvs server is composed |
| 106 |
+ |
from that specified by the <base> tag and the url argument of the |
| 107 |
+ |
<download> tag. |
| 108 |
+ |
<br> |
| 109 |
+ |
The <Config> tag tells scram that all other |
| 110 |
+ |
configuration files can be found in this config directory, and similarly |
| 111 |
+ |
the <RequirementsDoc> tag points scram to the |
| 112 |
+ |
<a href=requirementdoc.html>Requirements Document</a> |
| 113 |
+ |
<p> |
| 114 |
|
<! Style Sheet Footer ---------------Do not change anything after this line--> |
| 115 |
< |
<hr> |
| 115 |
> |
|
| 116 |
|
<table border=1 width=100%> |
| 117 |
|
<td align=left> |
| 118 |
< |
<a href=mailto:Christopher.Williams@cern.ch |
| 119 |
< |
>Chris Williams</a> |
| 85 |
< |
</td> |
| 86 |
< |
<td align=center> |
| 87 |
< |
Last Updated Wed Apr 19 17:09:09 2000 |
| 118 |
> |
<a href=mailto:Shaun.Ashby@cern.ch |
| 119 |
> |
>Shaun Ashby</a> |
| 120 |
|
</td> |
| 121 |
|
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a> |
| 122 |
|
</td> |
