| 1 |
williamc |
1.1 |
<! Style Sheet Header>
|
| 2 |
|
|
<html>
|
| 3 |
|
|
<head>
|
| 4 |
|
|
<title>localuse.html</title>
|
| 5 |
williamc |
1.3 |
<body bgcolor=beige>
|
| 6 |
williamc |
1.1 |
<! End Style Sheet Header -----------Insert Text Here --------------------->
|
| 7 |
williamc |
1.3 |
<center>
|
| 8 |
|
|
<h1>Using Scram as a Developer</h1>
|
| 9 |
|
|
<font color=red>S</font>oftware <font color=red>C</font>onfiguration,
|
| 10 |
|
|
<font color=red>R</font>elease <font color=red>A</font>nd
|
| 11 |
|
|
<font color=red>M</font>anagement
|
| 12 |
|
|
</center>
|
| 13 |
|
|
<hr>
|
| 14 |
sashby |
1.5 |
<p>
|
| 15 |
|
|
This page contains some useful information for developers using SCRAM, including how to set
|
| 16 |
|
|
up a private developer area and how to get more help.<p>
|
| 17 |
|
|
<p>
|
| 18 |
|
|
<h2>Online help</h2>
|
| 19 |
|
|
Help is available through the use of the global help command, or more specifically for
|
| 20 |
|
|
individual commands. <p>For example:
|
| 21 |
|
|
<p>
|
| 22 |
williamc |
1.3 |
<table>
|
| 23 |
|
|
<tr>
|
| 24 |
|
|
<td>
|
| 25 |
sashby |
1.5 |
<font size=3><pre>scram help</pre></font></td><td> will list the available scram commands</td>
|
| 26 |
williamc |
1.3 |
</tr>
|
| 27 |
|
|
<tr>
|
| 28 |
|
|
<td>
|
| 29 |
sashby |
1.5 |
<font size=3><pre>scram <em>command</em> help</pre></font></td><td> will list the help for a specific command</td>
|
| 30 |
williamc |
1.3 |
</tr>
|
| 31 |
|
|
<tr>
|
| 32 |
|
|
<td>
|
| 33 |
sashby |
1.5 |
<font size=3><pre>scram build help</pre></font></td><td> will list the available types of build you can perform in that location</td>
|
| 34 |
williamc |
1.3 |
</tr>
|
| 35 |
|
|
</table>
|
| 36 |
|
|
<p>
|
| 37 |
sashby |
1.5 |
<h2>Development Spaces</h2>
|
| 38 |
|
|
|
| 39 |
williamc |
1.3 |
<h3>What are Development Spaces?</h3>
|
| 40 |
sashby |
1.5 |
|
| 41 |
williamc |
1.3 |
A development space is an isolated area that you can use to work on a
|
| 42 |
|
|
given project without affecting anyone else. This development space is
|
| 43 |
|
|
associated with a specific installation of the project from which it can
|
| 44 |
|
|
draw resources (e.g libraries, include files, environment) as required.
|
| 45 |
williamc |
1.1 |
<br>
|
| 46 |
williamc |
1.3 |
SCRAM will only attempt to construct libraries/binaries etc.
|
| 47 |
|
|
if it cannot find appropriate versions in the central installation.
|
| 48 |
|
|
|
| 49 |
|
|
<h3>Creating Your Local Development Space</h3>
|
| 50 |
sashby |
1.5 |
|
| 51 |
williamc |
1.3 |
To develop on a given project you first need to have a copy of the project
|
| 52 |
|
|
installed at your site on which to base your development area.
|
| 53 |
sashby |
1.5 |
You can see the available locally installed copies of projects
|
| 54 |
williamc |
1.3 |
with the command :<p>
|
| 55 |
sashby |
1.5 |
<font size=3><pre> scram list</pre></font>
|
| 56 |
williamc |
1.3 |
<p>
|
| 57 |
|
|
To create your personal space you then issue the command:
|
| 58 |
williamc |
1.1 |
<p>
|
| 59 |
sashby |
1.5 |
<font size=3><pre>
|
| 60 |
|
|
scram project <em>project_name</em> <em>project_version</em>
|
| 61 |
|
|
</pre>
|
| 62 |
williamc |
1.1 |
</font>
|
| 63 |
williamc |
1.3 |
<p>
|
| 64 |
|
|
Where <em>project_name</em> and <em>project_version</em> correspond to those
|
| 65 |
sashby |
1.5 |
available from the project list.
|
| 66 |
|
|
<br>
|
| 67 |
williamc |
1.3 |
The development area will reflect the structure and will have the same
|
| 68 |
williamc |
1.1 |
build environment as the base project specified.
|
| 69 |
williamc |
1.3 |
<p>
|
| 70 |
sashby |
1.5 |
|
| 71 |
|
|
|
| 72 |
|
|
<h2>Using The Development Area</h2>
|
| 73 |
|
|
|
| 74 |
williamc |
1.1 |
Assuming you are at the top of your new development area:
|
| 75 |
sashby |
1.5 |
<p>
|
| 76 |
williamc |
1.1 |
<table border=0>
|
| 77 |
|
|
<tr>
|
| 78 |
|
|
<td>
|
| 79 |
sashby |
1.5 |
<font size=3>
|
| 80 |
|
|
<b>cd src</font></b></td><td>-change to the src directory</td></tr>
|
| 81 |
williamc |
1.1 |
<tr>
|
| 82 |
sashby |
1.5 |
<td valign=top><font size=3>
|
| 83 |
williamc |
1.3 |
<b>cvs co <em>module</em></b> (e.g. for cvs based projects)</font></td>
|
| 84 |
sashby |
1.5 |
<td>-check out whatever module you require. As an example, you may wish to
|
| 85 |
williamc |
1.1 |
develop a module that corresponds to a library. You will need to check-out the
|
| 86 |
|
|
entire module, rather than just the files your working on, as the library
|
| 87 |
|
|
building system uses the local file list to specify the library contents.
|
| 88 |
|
|
<p>
|
| 89 |
sashby |
1.5 |
-once checked out you can cd into the module and edit the files as
|
| 90 |
williamc |
1.2 |
required.
|
| 91 |
|
|
<p><em><b>Note</b> The cvs co command above will give you the development head.
|
| 92 |
|
|
If you wish to use a fixed tagged version or the head of a different
|
| 93 |
|
|
development branch you must specify this with the -r option to cvs.
|
| 94 |
|
|
<p>
|
| 95 |
sashby |
1.5 |
e.g. <font size=2><b>cvs co -r beta <em>module</em></b></font>
|
| 96 |
|
|
<br>
|
| 97 |
williamc |
1.2 |
</td>
|
| 98 |
williamc |
1.1 |
</tr>
|
| 99 |
sashby |
1.5 |
<td valign=top><font size=3>
|
| 100 |
williamc |
1.3 |
<b>
|
| 101 |
|
|
scram build</b></td>
|
| 102 |
williamc |
1.1 |
</font>
|
| 103 |
sashby |
1.5 |
<td>-perform the default build that corresponds to the directory in which
|
| 104 |
williamc |
1.1 |
you type the command.</td>
|
| 105 |
|
|
</tr>
|
| 106 |
|
|
</table>
|
| 107 |
sashby |
1.5 |
|
| 108 |
|
|
<h2>Runtime Environment</h2>
|
| 109 |
|
|
|
| 110 |
|
|
Each project you are working on is likely to have different and possibly
|
| 111 |
|
|
even conflicting environmental requirements during both runtime and build time.
|
| 112 |
|
|
SCRAM automatically takes care of the buildtime environment, though it is
|
| 113 |
|
|
unable to set your runtime environment for you. It can, however, tell you what
|
| 114 |
williamc |
1.3 |
the runtime environment should be for any given project. To see the
|
| 115 |
sashby |
1.5 |
required environment, simply issue the command<p>
|
| 116 |
|
|
<font size=3><pre> scram runtime [-csh|-sh]</pre></font>
|
| 117 |
williamc |
1.3 |
<p>
|
| 118 |
sashby |
1.5 |
from anywhere in a development space. Use the command<p>
|
| 119 |
|
|
<font size=3><pre> scram runtime help</pre></font>
|
| 120 |
williamc |
1.3 |
<p>
|
| 121 |
sashby |
1.5 |
for examples of usage.
|
| 122 |
|
|
<p>
|
| 123 |
williamc |
1.1 |
<! Style Sheet Footer ---------------Do not change anything after this line-->
|
| 124 |
|
|
<hr>
|
| 125 |
|
|
<table border=1 width=100%>
|
| 126 |
|
|
<td align=left>
|
| 127 |
sashby |
1.4 |
<a href=mailto:Shaun.Ashby@cern.ch
|
| 128 |
|
|
>Shaun Ashby</a>
|
| 129 |
williamc |
1.1 |
</td>
|
| 130 |
|
|
<td align=center>
|
| 131 |
|
|
<script language="JavaScript">
|
| 132 |
|
|
<!---//hide script from old browsers
|
| 133 |
|
|
document.write( "<br>Last updated "+ document.lastModified
|
| 134 |
|
|
);
|
| 135 |
|
|
//end hiding contents --->
|
| 136 |
|
|
</script>
|
| 137 |
|
|
</td>
|
| 138 |
|
|
<td align=right>Show <a href=/cgi-cmc/pagestat>Stats</a>
|
| 139 |
|
|
</td>
|
| 140 |
|
|
</table>
|
| 141 |
|
|
</body> </html>
|
| 142 |
|
|
<! End Style Sheet Footer>
|
