| 2 |
|
<html> |
| 3 |
|
<head> |
| 4 |
|
<title>localuse.html</title> |
| 5 |
< |
<body> |
| 5 |
> |
<body bgcolor=beige> |
| 6 |
|
<! End Style Sheet Header -----------Insert Text Here ---------------------> |
| 7 |
< |
Using scram in development. A simple example |
| 8 |
< |
<p> |
| 9 |
< |
<h2>Online help</h2> |
| 10 |
< |
Apart from these web pages, help is available through the use of the help |
| 11 |
< |
command. |
| 7 |
> |
<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 |
> |
<ol> |
| 15 |
> |
<li><h2>Online help</h2> |
| 16 |
> |
Help is available through the use of the help command. |
| 17 |
|
<p>e.g.<br> |
| 18 |
+ |
<table> |
| 19 |
+ |
<tr> |
| 20 |
+ |
<td> |
| 21 |
+ |
<font size=-1><b> |
| 22 |
+ |
scram help</b></font></td><td>will list the available scram commands</td> |
| 23 |
+ |
</tr> |
| 24 |
+ |
<tr> |
| 25 |
+ |
<td> |
| 26 |
|
<font size=-1> |
| 27 |
< |
scram help</font> will list the available scram commands |
| 28 |
< |
<br> |
| 29 |
< |
<font size=-1> |
| 30 |
< |
scram build help </font> List available build targets<br> |
| 31 |
< |
In general : |
| 27 |
> |
<b>scram <em>command</em> help</b></font></td> |
| 28 |
> |
<td> will list the help for that command</td> |
| 29 |
> |
</tr> |
| 30 |
> |
<tr> |
| 31 |
> |
<td> |
| 32 |
|
<font size=-1> |
| 33 |
< |
scram <em>command</em> help</font> will list the help for that command. |
| 34 |
< |
<h2>Creating your local development space</h2> |
| 35 |
< |
This section assumes that you have a locally installed copy of the project |
| 36 |
< |
you wish to work on. ( You can see the available locally installed copies |
| 24 |
< |
with the <font size=-1>scram list</font> command). |
| 33 |
> |
scram build help </font></td><td>Not working right now, but should list |
| 34 |
> |
the available types of build you can perform in that location</td> |
| 35 |
> |
</tr> |
| 36 |
> |
</table> |
| 37 |
|
<p> |
| 38 |
< |
<font size=-1> |
| 38 |
> |
<li><h2>Development Spaces</h2> |
| 39 |
> |
<h3>What are Development Spaces?</h3> |
| 40 |
> |
A development space is an isolated area that you can use to work on a |
| 41 |
> |
given project without affecting anyone else. This development space is |
| 42 |
> |
associated with a specific installation of the project from which it can |
| 43 |
> |
draw resources (e.g libraries, include files, environment) as required. |
| 44 |
> |
<h3>Creating Your Local Development Space</h3> |
| 45 |
> |
To develop on a given project you first need to have a copy of the project |
| 46 |
> |
installed at your site on which to base your development area. |
| 47 |
> |
You can see the available locally installed copies |
| 48 |
> |
with the command :<p> |
| 49 |
> |
<font size=-1><b>scram list</b></font> |
| 50 |
> |
<p> |
| 51 |
> |
To create your personal space you then issue the command: |
| 52 |
> |
<p> |
| 53 |
> |
<font size=-1><b> |
| 54 |
|
scram project <em>project_name</em> <em>project_version</em> |
| 55 |
+ |
</b> |
| 56 |
|
</font> |
| 57 |
< |
This command will create a development area. The development area will |
| 58 |
< |
reflect the structure and will have the same |
| 57 |
> |
<p> |
| 58 |
> |
Where <em>project_name</em> and <em>project_version</em> correspond to those |
| 59 |
> |
available from the <font size=-1><b>scram list</b></font> command. |
| 60 |
> |
<p> |
| 61 |
> |
The development area will reflect the structure and will have the same |
| 62 |
|
build environment as the base project specified. |
| 63 |
< |
<h2>Using The Development Area</h2> |
| 63 |
> |
<p> |
| 64 |
> |
<li><h2>Using The Development Area</h2> |
| 65 |
|
Assuming you are at the top of your new development area: |
| 66 |
|
<table border=0> |
| 67 |
|
<tr> |
| 68 |
|
<td> |
| 69 |
|
<font size=-1> |
| 70 |
< |
cd src</font></td><td> goto the src directory</td></tr> |
| 70 |
> |
<b>cd src</font></b></td><td> goto the src directory</td></tr> |
| 71 |
|
<tr> |
| 72 |
< |
<td><font size=-1> |
| 73 |
< |
cvs co <em>module</em> (e.g. for cvs based projects)</font></td> |
| 72 |
> |
<td valign=top><font size=-1> |
| 73 |
> |
<b>cvs co <em>module</em></b> (e.g. for cvs based projects)</font></td> |
| 74 |
|
<td>Check out whatever module you require. As an example, you may wish to |
| 75 |
|
develop a module that corresponds to a library. You will need to check-out the |
| 76 |
|
entire module, rather than just the files your working on, as the library |
| 82 |
|
If you wish to use a fixed tagged version or the head of a different |
| 83 |
|
development branch you must specify this with the -r option to cvs. |
| 84 |
|
<p> |
| 85 |
< |
e.g. <font size=-1>cvs co -r beta <em>module</em> |
| 85 |
> |
e.g. <font size=-1><b>cvs co -r beta <em>module</em></b> |
| 86 |
|
</font> |
| 87 |
|
<p> |
| 88 |
|
</td> |
| 89 |
|
</tr> |
| 90 |
< |
<td><font size=-1> |
| 91 |
< |
scram build</td> |
| 90 |
> |
<td valign=top><font size=-1> |
| 91 |
> |
<b> |
| 92 |
> |
scram build</b></td> |
| 93 |
|
</font> |
| 94 |
|
<td>Will perform the default build that corresponds to the directory in which |
| 95 |
|
you type the command.</td> |
| 96 |
|
</tr> |
| 97 |
|
</table> |
| 98 |
+ |
<li><h2>Runtime Environment</h2> |
| 99 |
+ |
Each project you are working on is likeley to have different and possibly |
| 100 |
+ |
even conflicting Environmental requirements during both runtime and build time. |
| 101 |
+ |
SCRAM automatically takes care of the buildtime environment, however it is |
| 102 |
+ |
unable to set your runtime environment for you. It can however tell you what |
| 103 |
+ |
the runtime environment should be for any given project. To see the |
| 104 |
+ |
required environment simply issue the <p> |
| 105 |
+ |
<font size=-1><b>scram runtime [-csh|-sh]</b></font> |
| 106 |
+ |
<p> |
| 107 |
+ |
command from anywhere in a development space. Use the command<p> |
| 108 |
+ |
<font size=-1><b>scram runtime help</b></font> |
| 109 |
+ |
<p> |
| 110 |
+ |
for examples of use. |
| 111 |
+ |
</ol> |
| 112 |
|
<! Style Sheet Footer ---------------Do not change anything after this line--> |
| 113 |
|
<hr> |
| 114 |
|
<table border=1 width=100%> |
