| 1 |
+ |
<! Style Sheet Header> |
| 2 |
+ |
<html> |
| 3 |
+ |
<head> |
| 4 |
+ |
<title>requirementdoc.html</title> |
| 5 |
+ |
<body bgcolor=beige> |
| 6 |
+ |
<! End Style Sheet Header -----------Insert Text Here ---------------------> |
| 7 |
+ |
<center> |
| 8 |
+ |
<h2>The Requirements Document (Version 2.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 Requirements Document is an <a href=ActiveDoc.html>ActiveDoc</a><br> |
| 16 |
+ |
The Requirement Document is used to specify which external products |
| 17 |
+ |
(libraries etc.) are needed for the project (the configuration). |
| 18 |
+ |
If more than one version of any given tool is specified |
| 19 |
+ |
the first is the one taken as the default. This can be overridden in the |
| 20 |
+ |
<A href=versiondefs.html>External_dependencies</a> configuration file. |
| 21 |
+ |
<p> |
| 22 |
+ |
<h2>Tags</h2> |
| 23 |
+ |
<table border=1> |
| 24 |
+ |
<tr> |
| 25 |
+ |
<td> |
| 26 |
+ |
<font color=green> |
| 27 |
+ |
<doc type=BuildSystem::Requirements version=2.0> |
| 28 |
+ |
</font> |
| 29 |
+ |
</td> |
| 30 |
+ |
<td> |
| 31 |
+ |
This indicates to SCRAM what type of document it is (and thus how to parse it) |
| 32 |
+ |
</td> |
| 33 |
+ |
</tr> |
| 34 |
+ |
<tr> |
| 35 |
+ |
<td> |
| 36 |
+ |
<font color=green> |
| 37 |
+ |
<require name=<em>tool_name</em> version=<em>tool_version</em> |
| 38 |
+ |
url=<em>ToolDoc</em>> |
| 39 |
+ |
<br> |
| 40 |
+ |
<em>Descriptive Comments</em> |
| 41 |
+ |
<br> |
| 42 |
+ |
</require> |
| 43 |
+ |
</font> |
| 44 |
+ |
</td> |
| 45 |
+ |
<td> |
| 46 |
+ |
Specify the name and version of a required tool. |
| 47 |
+ |
The url should point to the |
| 48 |
+ |
<a href=configurationtools.html>ToolDoc</a> that describes the requested tool |
| 49 |
+ |
The url can be modified by <a href=ActiveDoc.html><Base> tags</a> |
| 50 |
+ |
By default the tool is also selected for use in the project -i.e. scheduled |
| 51 |
+ |
to be set up in the configuration area etc. This can be modified with the |
| 52 |
+ |
<restrict> tags described below. |
| 53 |
+ |
</td> |
| 54 |
+ |
</tr> |
| 55 |
+ |
<tr> |
| 56 |
+ |
<td> |
| 57 |
+ |
<font color=green> |
| 58 |
+ |
<download url=<em>download_link</em>> |
| 59 |
+ |
</font> |
| 60 |
+ |
</td> |
| 61 |
+ |
<td> |
| 62 |
+ |
Provide a link to download information for the requiremnt |
| 63 |
+ |
</td> |
| 64 |
+ |
</tr> |
| 65 |
+ |
<tr> |
| 66 |
+ |
<td> |
| 67 |
+ |
<font color=green> |
| 68 |
+ |
<Restrict autoselect=<em>true|false</em>><br> |
| 69 |
+ |
</Restrict> |
| 70 |
+ |
</font> |
| 71 |
+ |
</td> |
| 72 |
+ |
<td> |
| 73 |
+ |
Define the limits of a restriction on the way <require> tags are handled. |
| 74 |
+ |
<br>Outside these tags <em>autoselect=true</em>. |
| 75 |
+ |
</td> |
| 76 |
+ |
</tr> |
| 77 |
+ |
<tr> |
| 78 |
+ |
<td> |
| 79 |
+ |
<font color=green> |
| 80 |
+ |
<select name=<em>tool_name</em>> |
| 81 |
+ |
</font> |
| 82 |
+ |
</td> |
| 83 |
+ |
<td> |
| 84 |
+ |
Selects the tool refered to by name which should correspond to a <require> |
| 85 |
+ |
tag. |
| 86 |
+ |
For use inside a <restrict> context where autoselect=false. |
| 87 |
+ |
</td> |
| 88 |
+ |
</tr> |
| 89 |
+ |
<tr> |
| 90 |
+ |
<td> |
| 91 |
+ |
<font color=green> |
| 92 |
+ |
<deselect name=<em>tool_name</em>> |
| 93 |
+ |
</font> |
| 94 |
+ |
</td> |
| 95 |
+ |
<td> |
| 96 |
+ |
Deselects the tool refered to by name which should correspond to a <require> |
| 97 |
+ |
tag. |
| 98 |
+ |
For use inside a <restrict> context where autoselect=true. |
| 99 |
+ |
</td> |
| 100 |
+ |
</tr> |
| 101 |
+ |
</table> |
| 102 |
+ |
|
| 103 |
+ |
<h2>Example</h2> |
| 104 |
+ |
<font color=green> |
| 105 |
+ |
<pre> |
| 106 |
+ |
<doc type=BuildSystem::Requirements version=2.0> |
| 107 |
+ |
<base url="cvs://cmscvs.cern.ch/cvs_server/repositories/SCRAM?auth=pserver&user=anonymous&passkey=AA_:yZZ3e"> |
| 108 |
+ |
<require name=test version=version1 url="cvs:?module=test/testtool&version=A"> |
| 109 |
+ |
This requiremnt refers to a dummy test document used in scram regression tests |
| 110 |
+ |
</require> |
| 111 |
+ |
<Restrict autoselect=false> |
| 112 |
+ |
<include url="cvs:?module=test/testreqs"> <font color=black>You can include common configuration files</font> |
| 113 |
+ |
<select name=yetanothertool> <font color=black>Then select from a subset of them</font> |
| 114 |
+ |
</Restrict> |
| 115 |
+ |
<Restrict autoselect=true> |
| 116 |
+ |
<include url="cvs:?module=test/testreqs2"> |
| 117 |
+ |
<deselect name=ToolA> <font color=black>As in the example above but this time dropping tools from a common configuration</font> |
| 118 |
+ |
</Restrict> |
| 119 |
+ |
</base> |
| 120 |
+ |
</pre> |
| 121 |
+ |
</font> |
| 122 |
+ |
<! Style Sheet Footer ---------------Do not change anything after this line--> |
| 123 |
+ |
<hr> |
| 124 |
+ |
<table border=1 width=100%> |
| 125 |
+ |
<td align=left> |
| 126 |
+ |
<a href=mailto:Christopher.Williams@cern.ch |
| 127 |
+ |
>Chris Williams</a> |
| 128 |
+ |
</td> |
| 129 |
+ |
<td align=center> |
| 130 |
+ |
Last Updated Tue Aug 22 16:59:11 2000 |
| 131 |
+ |
</td> |
| 132 |
+ |
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a> |
| 133 |
+ |
</td> |
| 134 |
+ |
</table> |
| 135 |
+ |
</body> </html> |
| 136 |
+ |
<! End Style Sheet Footer> |
