ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/requirementdoc.html
Revision: 1.1.2.5.2.1
Committed: Wed Aug 9 15:52:36 2000 UTC (24 years, 9 months ago) by williamc
Content type: text/html
Branch: HPWbranch
Changes since 1.1.2.5: +1 -1 lines
Log Message:
Correct tag name

File Contents

# User Rev Content
1 williamc 1.1.2.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</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>
16     The Requirement Document is used to specify which external libraries etc. are
17 williamc 1.1.2.3 needed for the project. If more than one version of any given tool is specified
18     the first is the one taken as the default. This can be overridden in the
19 williamc 1.1.2.2 <A href=versiondefs.html>External_dependencies</a> configuration file.
20 williamc 1.1.2.1 <p>
21     <h2>Tags</h2>
22     <table border=1>
23     <tr>
24     <td>
25     <font color=green>
26 williamc 1.1.2.4 &lt;doc type=BuildSystem::Requirements version=<em>version</em>>
27     </font>
28     </td>
29     <td>
30     This indicates to SCRAM what type of document it is (and thus how to parse it)
31     At the moment all that is required is for the tag to exist however expect this
32     requirement to change.
33     </td>
34     </tr>
35     <tr>
36     <td>
37     <font color=green>
38 williamc 1.1.2.5.2.1 &lt;require name=<em>tool_name</em> version=<em>tool_version</em>
39 williamc 1.1.2.1 file=<em>ToolDoc</em>>
40 williamc 1.1.2.5 <br>
41     <em>Descriptive Comments</em>
42     <br>
43     &lt;/require>
44 williamc 1.1.2.1 </font>
45     </td>
46     <td>
47     Specify the name and version of the required tool.
48     The file should point to the
49     <a href=configurationtools.html>ToolDoc</a> that describes the requested tool
50     </td>
51     </tr>
52 williamc 1.1.2.5 <tr>
53     <td>
54     <font color=green>
55     &lt;download url=<em>download_link</em>>
56     </font>
57     </td>
58     <td>
59     Provide a link to download information for the requiremnt
60     </td>
61     </tr>
62 williamc 1.1.2.1 </table>
63    
64     <! Style Sheet Footer ---------------Do not change anything after this line-->
65     <hr>
66     <table border=1 width=100%>
67     <td align=left>
68     <a href=mailto:Christopher.Williams@cern.ch
69     >Chris Williams</a>
70     </td>
71     <td align=center>
72 williamc 1.1.2.5 Last Updated Fri May 12 12:42:26 2000
73 williamc 1.1.2.1 </td>
74     <td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
75     </td>
76     </table>
77     </body> </html>
78     <! End Style Sheet Footer>