1 |
williamc |
1.2 |
<! Style Sheet Header>
|
2 |
|
|
<html>
|
3 |
|
|
<head>
|
4 |
|
|
<title>projectconfig.html</title>
|
5 |
|
|
<body bgcolor=beige>
|
6 |
|
|
<! End Style Sheet Header -----------Insert Text Here --------------------->
|
7 |
|
|
<center>
|
8 |
williamc |
1.3 |
<h2>Defining SCRAM Projects</h2>
|
9 |
williamc |
1.2 |
<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 |
williamc |
1.3 |
<h1>Quick Links</h1>
|
16 |
williamc |
1.2 |
<ul>
|
17 |
|
|
<li><a href=ActiveDoc.html>The ActiveDoc System</a>
|
18 |
|
|
<li><a href=bootstrap.html>The BootStrap ActiveDoc</a>
|
19 |
|
|
<li><a href=requirementdoc.html>The Requirements ActiveDoc</a>
|
20 |
|
|
<li><a href=versiondefs.html>Overidding Default Versions</a>
|
21 |
|
|
<li><a href=configBuildFile.html>The Project BuildFiles</a>
|
22 |
williamc |
1.3 |
<li><a href=runtime.html>The Project Runtime Environment</a>
|
23 |
williamc |
1.2 |
</ul>
|
24 |
williamc |
1.3 |
<h1>Elements of a SCRAM project</h1>
|
25 |
|
|
<img src=../images/project.jpg>
|
26 |
|
|
<p>
|
27 |
|
|
To define a new project you need to specify three sets of configuration files
|
28 |
|
|
corresponding to the areas of distribution, configuration and the build system.
|
29 |
sashby |
1.6 |
Configuration files are written as XML-like documents called <a href=ActiveDoc.html>ActiveDocs</a>.
|
30 |
williamc |
1.3 |
<p>
|
31 |
|
|
<ol>
|
32 |
|
|
<li>Project Structure and Distribution is described by a <a href=bootstrap.html>BootStrap Document</a><br>
|
33 |
|
|
There should be at least one bootstrap document for each project. Any number of others can be added to
|
34 |
|
|
describe different distributions and access methods.
|
35 |
|
|
e.g. a developers distribution may contain the full source code
|
36 |
sashby |
1.6 |
whereas a users distribution may just contain the header files, and a release distributed via a CD
|
37 |
williamc |
1.3 |
will require a different BootStrap to one intended for downloading everything from the internet.<br>
|
38 |
|
|
The BootStrap file will also tell SCRAM where to find all the other
|
39 |
|
|
configuration files by naming a <em>configuration directory</em> and a
|
40 |
|
|
<em>Requirements Document</em>
|
41 |
sashby |
1.6 |
|
42 |
williamc |
1.3 |
<li>You describe the configuration profile in a <a href=requirementdoc.html>Requirements Document</a>
|
43 |
|
|
This document will tell SCRAM what to put in your projects toolbox. You will only be able to use
|
44 |
|
|
tools in this toolbox. In your configuration directory you will also need to specify the
|
45 |
williamc |
1.4 |
specific SCRAM version you are using by creating a <a href=http:versionsel.html#Auto>scram_version</a> file
|
46 |
williamc |
1.3 |
<li>The <a href=configBuildFile.html>Project BuildFiles</a> tells the scram
|
47 |
|
|
build system how to construct your project
|
48 |
|
|
<li>The Project Runtime document tells scram
|
49 |
|
|
about project wide environmental variables. To
|
50 |
|
|
set these variables you should create a
|
51 |
|
|
<a href=runtime.html>Runtime Document</a> called <em>Runtime</em> in
|
52 |
|
|
your configuration directory.
|
53 |
|
|
</ol>
|
54 |
williamc |
1.2 |
<! Style Sheet Footer ---------------Do not change anything after this line-->
|
55 |
|
|
<hr>
|
56 |
|
|
<table border=1 width=100%>
|
57 |
|
|
<td align=left>
|
58 |
sashby |
1.5 |
<a href=mailto:Shaun.Ashby@cern.ch
|
59 |
|
|
>Shaun Ashby</a>
|
60 |
williamc |
1.2 |
</td>
|
61 |
|
|
<td align=center>
|
62 |
sashby |
1.5 |
<SCRIPT LANGUAGE="JAVASCRIPT">document.write("Last Updated "+ document.lastModified );</SCRIPT>
|
63 |
williamc |
1.2 |
</td>
|
64 |
|
|
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
|
65 |
|
|
</td>
|
66 |
|
|
</table>
|
67 |
|
|
</body> </html>
|
68 |
|
|
<! End Style Sheet Footer>
|