doc/html/node19.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
patched version by:  Kenshi Muto, Debian Project.
LaTeX2HTML 2002 (1.62),
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>3.1.1 The BootStrapProject Class</TITLE>
<META NAME="description" CONTENT="3.1.1 The BootStrapProject Class">
<META NAME="keywords" CONTENT="SCRAM">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="SCRAM.css">

<LINK REL="next" HREF="node21.html">
<LINK REL="previous" HREF="node18.html">
<LINK REL="up" HREF="node18.html">
<LINK REL="next" HREF="node20.html">
</HEAD>

<BODY bgcolor="beige" >
<!--Navigation Panel-->
<A NAME="tex2html610"
  HREF="node20.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
 SRC="file:/usr/share/latex2html/icons/next.png"></A> 
<A NAME="tex2html604"
  HREF="node18.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="file:/usr/share/latex2html/icons/up.png"></A> 
<A NAME="tex2html598"
  HREF="node18.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="file:/usr/share/latex2html/icons/prev.png"></A> 
<A NAME="tex2html606"
  HREF="node2.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
 SRC="file:/usr/share/latex2html/icons/contents.png"></A> 
<A NAME="tex2html608"
  HREF="node85.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
 SRC="file:/usr/share/latex2html/icons/index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html611"
  HREF="node20.html">3.1.1.0.1 Example:</A>
<B> Up:</B> <A NAME="tex2html605"
  HREF="node18.html">3.1 SCRAM Configuration Documents</A>
<B> Previous:</B> <A NAME="tex2html599"
  HREF="node18.html">3.1 SCRAM Configuration Documents</A>
 &nbsp <B>  <A NAME="tex2html607"
  HREF="node2.html">Contents</A></B> 
 &nbsp <B>  <A NAME="tex2html609"
  HREF="node85.html">Index</A></B> 
<BR>
<BR>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00411000000000000000"></A><A NAME="sec:bootstrapclass"></A>
<BR>
3.1.1 The BootStrapProject Class
</H2>
<A NAME="1829"></A>
A single document describes how the project should be configured.
Usually referred to as a <TT>bootstrap</TT> file, it must start with
the statement<A NAME="1830"></A> 
<A NAME="463"></A>

<UL>
&lt;<TT>doc</TT> type=<TT>Configuration::BootStrapProject</TT>
  version=<I>1.0</I>&gt; 
</LI>
</UL>The name of this file is completely arbitrary.  The function of
the bootstrap document is to define the name and version of a project
and to tell <SMALL>SCRAM</SMALL>&nbsp;from where it can download the configuration and
source code files, and where to put them inside the project release
area. There must be a bootstrapfile in every <SMALL>SCRAM</SMALL>&nbsp;project.

<P>
The markup tags specify a path to a CVS server, the name of the
project requirements document and the location of the project
configuration directory within the project area.  The available markup
tags are as follows-
<A NAME="1831"></A>
<A NAME="1832"></A> 
<DL>
<DT><STRONG>&lt;<TT>project</TT> name=<I>name</I> version=<I>version</I>&gt;&nbsp;&lt;/<TT>project</TT>&gt; </STRONG></DT>
<DD>
<BR>
Specify the name an version of the project. The version should be a
  valid CVS symbolic tag which must exist on all files in the
  configuration directory and the project source code. Explanatory
  text can be put between the &lt;<TT>project</TT>...&gt; tags: this
  text will be printed to the screen when bootstrapping the project.
</DD>
<DT><STRONG>&lt;<TT>config</TT> dir=<I>dirname</I>&gt; </STRONG></DT>
<DD>
<BR>
Specify the name of a directory relative to the top of the project
  area where the configuration files can be found.
</DD>
<DT><STRONG>&lt;<TT>base</TT> url=<I>baseurl</I>&gt;&nbsp;&lt;/<TT>base</TT>&gt; </STRONG></DT>
<DD>
<BR>
A common element in multiple URLs, such as a CVS server name, is
  supplied using the base tag. The URL type can be <TT>cvs:</TT>
  (using a CVS repository) or <TT>file:</TT> (a standalone file). Any
  URL specified between the start and end base tags will be merged
  with the URL <I>baseurl</I> according to the following merge
  rules:
  
<UL>
<LI>A merge will only take place if the URL and <I>baseurl</I>
    types match, e.g. both have type <TT>cvs:</TT> or <TT>file:</TT>
</LI>
<LI>The base server name is taken if it isn't already defined
</LI>
<LI>The <I>baseurl</I> path is prepended to any URL specified
</LI>
<LI>Variables provided in the base parameter list are only added
    if not already defined, e.g. definition of the directory name when
    downloading the configuration files
  
</LI>
</UL>
</DD>
<DT><STRONG>&lt;<TT>download</TT> url=<I>url</I> name=<I>dirname</I>&gt; </STRONG></DT>
<DD>
<BR>
Each URL will be merged with the base URL defined in a
  &lt;<TT>base</TT>&gt;  tag and treated as a download location which is
  passed to CVS for checking out files from a repository. The name of
  the destination directory will be <I>dirname</I>, and will be
  located relative to the top of the project area.
</DD>
<DT><STRONG>&lt;<TT>requirementsdoc</TT> name=<I>docname</I>&gt; </STRONG></DT>
<DD>
<BR>
Specify the name of the project requirements document. The path is
  relative to the top of the project area.
</DD>
</DL>

<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>

<UL>
<LI><UL>
<LI><A NAME="tex2html612"
  HREF="node20.html">3.1.1.0.1 <I>Example</I>:</A>
</UL></UL>
<!--End of Table of Child-Links-->
<HR>
<!--Navigation Panel-->
<A NAME="tex2html610"
  HREF="node20.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
 SRC="file:/usr/share/latex2html/icons/next.png"></A> 
<A NAME="tex2html604"
  HREF="node18.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="file:/usr/share/latex2html/icons/up.png"></A> 
<A NAME="tex2html598"
  HREF="node18.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="file:/usr/share/latex2html/icons/prev.png"></A> 
<A NAME="tex2html606"
  HREF="node2.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
 SRC="file:/usr/share/latex2html/icons/contents.png"></A> 
<A NAME="tex2html608"
  HREF="node85.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
 SRC="file:/usr/share/latex2html/icons/index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html611"
  HREF="node20.html">3.1.1.0.1 Example:</A>
<B> Up:</B> <A NAME="tex2html605"
  HREF="node18.html">3.1 SCRAM Configuration Documents</A>
<B> Previous:</B> <A NAME="tex2html599"
  HREF="node18.html">3.1 SCRAM Configuration Documents</A>
 &nbsp <B>  <A NAME="tex2html607"
  HREF="node2.html">Contents</A></B> 
 &nbsp <B>  <A NAME="tex2html609"
  HREF="node85.html">Index</A></B> 
<!--End of Navigation Panel-->
<ADDRESS>
scram-developers@cern.ch
</ADDRESS>
</BODY>
</HTML>
Revision:	1.2
Committed:	Fri Dec 10 13:52:37 2004 UTC (20 years, 5 months ago) by sashby
Content type:	text/html
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.1:	+0 -0 lines
State:	*FILE REMOVED*
Log Message:	* empty log message *
#	User	Rev	Content
1	sashby	1.1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
3			<!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
4			patched version by: Kenshi Muto, Debian Project.
5			LaTeX2HTML 2002 (1.62),
6			original version by: Nikos Drakos, CBLU, University of Leeds
7			* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
8			* with significant contributions from:
9			Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
10			<HTML>
11			<HEAD>
12			<TITLE>3.1.1 The BootStrapProject Class</TITLE>
13			<META NAME="description" CONTENT="3.1.1 The BootStrapProject Class">
14			<META NAME="keywords" CONTENT="SCRAM">
15			<META NAME="resource-type" CONTENT="document">
16			<META NAME="distribution" CONTENT="global">
17
18			<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
19			<META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
20			<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
21
22			<LINK REL="STYLESHEET" HREF="SCRAM.css">
23
24			<LINK REL="next" HREF="node21.html">
25			<LINK REL="previous" HREF="node18.html">
26			<LINK REL="up" HREF="node18.html">
27			<LINK REL="next" HREF="node20.html">
28			</HEAD>
29
30			<BODY bgcolor="beige" >
31			<!--Navigation Panel-->
32			<A NAME="tex2html610"
33			HREF="node20.html">
34			<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
35			SRC="file:/usr/share/latex2html/icons/next.png"></A>
36			<A NAME="tex2html604"
37			HREF="node18.html">
38			<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
39			SRC="file:/usr/share/latex2html/icons/up.png"></A>
40			<A NAME="tex2html598"
41			HREF="node18.html">
42			<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
43			SRC="file:/usr/share/latex2html/icons/prev.png"></A>
44			<A NAME="tex2html606"
45			HREF="node2.html">
46			<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
47			SRC="file:/usr/share/latex2html/icons/contents.png"></A>
48			<A NAME="tex2html608"
49			HREF="node85.html">
50			<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
51			SRC="file:/usr/share/latex2html/icons/index.png"></A>
52			<BR>
53			<B> Next:</B> <A NAME="tex2html611"
54			HREF="node20.html">3.1.1.0.1 Example:</A>
55			<B> Up:</B> <A NAME="tex2html605"
56			HREF="node18.html">3.1 SCRAM Configuration Documents</A>
57			<B> Previous:</B> <A NAME="tex2html599"
58			HREF="node18.html">3.1 SCRAM Configuration Documents</A>
59			&nbsp <B> <A NAME="tex2html607"
60			HREF="node2.html">Contents</A></B>
61			&nbsp <B> <A NAME="tex2html609"
62			HREF="node85.html">Index</A></B>
63			<BR>
64			<BR>
65			<!--End of Navigation Panel-->
66
67			<H2><A NAME="SECTION00411000000000000000"></A><A NAME="sec:bootstrapclass"></A>
68			<BR>
69			3.1.1 The BootStrapProject Class
70			</H2>
71			<A NAME="1829"></A>
72			A single document describes how the project should be configured.
73			Usually referred to as a <TT>bootstrap</TT> file, it must start with
74			the statement<A NAME="1830"></A>
75			<A NAME="463"></A>
76
77			<UL>
78			<<TT>doc</TT> type=<TT>Configuration::BootStrapProject</TT>
79			version=<I>1.0</I>>
80			</LI>
81			</UL>The name of this file is completely arbitrary. The function of
82			the bootstrap document is to define the name and version of a project
83			and to tell <SMALL>SCRAM</SMALL> from where it can download the configuration and
84			source code files, and where to put them inside the project release
85			area. There must be a bootstrapfile in every <SMALL>SCRAM</SMALL> project.
86
87			<P>
88			The markup tags specify a path to a CVS server, the name of the
89			project requirements document and the location of the project
90			configuration directory within the project area. The available markup
91			tags are as follows-
92			<A NAME="1831"></A>
93			<A NAME="1832"></A>
94			<DL>
95			<DT><STRONG><<TT>project</TT> name=<I>name</I> version=<I>version</I>> </<TT>project</TT>> </STRONG></DT>
96			<DD>
97			<BR>
98			Specify the name an version of the project. The version should be a
99			valid CVS symbolic tag which must exist on all files in the
100			configuration directory and the project source code. Explanatory
101			text can be put between the <<TT>project</TT>...> tags: this
102			text will be printed to the screen when bootstrapping the project.
103			</DD>
104			<DT><STRONG><<TT>config</TT> dir=<I>dirname</I>> </STRONG></DT>
105			<DD>
106			<BR>
107			Specify the name of a directory relative to the top of the project
108			area where the configuration files can be found.
109			</DD>
110			<DT><STRONG><<TT>base</TT> url=<I>baseurl</I>> </<TT>base</TT>> </STRONG></DT>
111			<DD>
112			<BR>
113			A common element in multiple URLs, such as a CVS server name, is
114			supplied using the base tag. The URL type can be <TT>cvs:</TT>
115			(using a CVS repository) or <TT>file:</TT> (a standalone file). Any
116			URL specified between the start and end base tags will be merged
117			with the URL <I>baseurl</I> according to the following merge
118			rules:
119
120			<UL>
121			<LI>A merge will only take place if the URL and <I>baseurl</I>
122			types match, e.g. both have type <TT>cvs:</TT> or <TT>file:</TT>
123			</LI>
124			<LI>The base server name is taken if it isn't already defined
125			</LI>
126			<LI>The <I>baseurl</I> path is prepended to any URL specified
127			</LI>
128			<LI>Variables provided in the base parameter list are only added
129			if not already defined, e.g. definition of the directory name when
130			downloading the configuration files
131
132			</LI>
133			</UL>
134			</DD>
135			<DT><STRONG><<TT>download</TT> url=<I>url</I> name=<I>dirname</I>> </STRONG></DT>
136			<DD>
137			<BR>
138			Each URL will be merged with the base URL defined in a
139			<<TT>base</TT>> tag and treated as a download location which is
140			passed to CVS for checking out files from a repository. The name of
141			the destination directory will be <I>dirname</I>, and will be
142			located relative to the top of the project area.
143			</DD>
144			<DT><STRONG><<TT>requirementsdoc</TT> name=<I>docname</I>> </STRONG></DT>
145			<DD>
146			<BR>
147			Specify the name of the project requirements document. The path is
148			relative to the top of the project area.
149			</DD>
150			</DL>
151
152			<P>
153			<BR><HR>
154			<!--Table of Child-Links-->
155			<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
156
157			<UL>
158			<LI><UL>
159			<LI><A NAME="tex2html612"
160			HREF="node20.html">3.1.1.0.1 <I>Example</I>:</A>
161			</UL></UL>
162			<!--End of Table of Child-Links-->
163			<HR>
164			<!--Navigation Panel-->
165			<A NAME="tex2html610"
166			HREF="node20.html">
167			<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
168			SRC="file:/usr/share/latex2html/icons/next.png"></A>
169			<A NAME="tex2html604"
170			HREF="node18.html">
171			<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
172			SRC="file:/usr/share/latex2html/icons/up.png"></A>
173			<A NAME="tex2html598"
174			HREF="node18.html">
175			<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
176			SRC="file:/usr/share/latex2html/icons/prev.png"></A>
177			<A NAME="tex2html606"
178			HREF="node2.html">
179			<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
180			SRC="file:/usr/share/latex2html/icons/contents.png"></A>
181			<A NAME="tex2html608"
182			HREF="node85.html">
183			<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
184			SRC="file:/usr/share/latex2html/icons/index.png"></A>
185			<BR>
186			<B> Next:</B> <A NAME="tex2html611"
187			HREF="node20.html">3.1.1.0.1 Example:</A>
188			<B> Up:</B> <A NAME="tex2html605"
189			HREF="node18.html">3.1 SCRAM Configuration Documents</A>
190			<B> Previous:</B> <A NAME="tex2html599"
191			HREF="node18.html">3.1 SCRAM Configuration Documents</A>
192			&nbsp <B> <A NAME="tex2html607"
193			HREF="node2.html">Contents</A></B>
194			&nbsp <B> <A NAME="tex2html609"
195			HREF="node85.html">Index</A></B>
196			<!--End of Navigation Panel-->
197			<ADDRESS>
198			scram-developers@cern.ch
199			</ADDRESS>
200			</BODY>
201			</HTML>