ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/localuse.html
Revision: 1.1
Committed: Mon Mar 22 16:00:31 1999 UTC (26 years, 2 months ago) by williamc
Content type: text/html
Branch: MAIN
CVS Tags: V0_1
Log Message:
Initial Documentation - minimal

File Contents

# Content
1 <! Style Sheet Header>
2 <html>
3 <head>
4 <title>localuse.html</title>
5 <body>
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.
12 <p>e.g.<br>
13 <font size=-1>
14 scram help</font> will list the available scram commands
15 <br>
16 <font size=-1>
17 scram build help </font> List available build targets<br>
18 In general :
19 <font size=-1>
20 scram <em>command</em> help</font> will list the help for that command.
21 <h2>Creating your local development space</h2>
22 This section assumes that you have a locally installed copy of the project
23 you wish to work on. ( You can see the available locally installed copies
24 with the <font size=-1>scram list</font> command).
25 <p>
26 <font size=-1>
27 scram project <em>project_name</em> <em>project_version</em>
28 </font>
29 This command will create a development area. The development area will
30 reflect the structure and will have the same
31 build environment as the base project specified.
32 <h2>Using The Development Area</h2>
33 Assuming you are at the top of your new development area:
34 <table border=0>
35 <tr>
36 <td>
37 <font size=-1>
38 cd src</font></td><td> goto the src directory</td></tr>
39 <tr>
40 <td><font size=-1>
41 cvs co <em>module</em> (e.g. for cvs based projects)</font></td>
42 <td>Check out whatever module you require. As an example, you may wish to
43 develop a module that corresponds to a library. You will need to check-out the
44 entire module, rather than just the files your working on, as the library
45 building system uses the local file list to specify the library contents.
46 <p>
47 Once checked out you can cd into the module and edit the files as
48 required.</td>
49 </tr>
50 <td><font size=-1>
51 scram build</td>
52 </font>
53 <td>Will perform the default build that corresponds to the directory in which
54 you type the command.</td>
55 </tr>
56 </table>
57 <! Style Sheet Footer ---------------Do not change anything after this line-->
58 <hr>
59 <table border=1 width=100%>
60 <td align=left>
61 <a href=mailto:Christopher.Williams@cern.ch
62 >Chris Williams</a>
63 </td>
64 <td align=center>
65 <script language="JavaScript">
66 <!---//hide script from old browsers
67 document.write( "<br>Last updated "+ document.lastModified
68 );
69 //end hiding contents --->
70 </script>
71 </td>
72 <td align=right>Show <a href=/cgi-cmc/pagestat>Stats</a>
73 </td>
74 </table>
75 </body> </html>
76 <! End Style Sheet Footer>