rubys 01/09/24 22:22:28
Modified: proposal/gump/site/xdocs module.xml overview.xml profile.xml
workspace.xml
proposal/gump/site/xdocs/stylesheets project.xml
Removed: proposal/gump/site/xdocs velocity.properties
Log:
Next installment of documentation...
Revision Changes Path
1.2 +64 -5 jakarta-alexandria/proposal/gump/site/xdocs/module.xml
Index: module.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/module.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- module.xml 2001/09/25 02:30:35 1.1
+++ module.xml 2001/09/25 05:22:27 1.2
@@ -9,22 +9,81 @@
<body>
<section name="module">
- <p>TBD</p>
+ <p>A <a href="module.html">module</a> is a collection of projects that
+ are physically stored in a single repository.</p>
<subsection name="url">
- <p></p>
+ <p>This is the homepage for the collection of projects contained in
+ this module. This element is optional, but if present, will be
+ referenced in the generated web pages containing build results.</p>
+
+ <p>Note: give the way that gump uses href to specify definitions which
+ are to be inlined, the design of this element is rather unfortunate.
+ Perhaps it should be replaced with a <home-page> element.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>href</td>
+ <td>URL of home page</td>
+ <td>Yes.</td>
+ </tr>
+ </table>
</subsection>
<subsection name="description">
- <p></p>
+ <p>If present, will contain information added to the title in web
+ pages containing build results.</p>
</subsection>
<subsection name="cvs">
- <p></p>
+ <p>References the <a href="repository.html">repository</a> in which
+ this project resides. May also contain various overrides.</p>
+
+ <p>Note: as the long term plans is to make Gump handle many different
+ types of repository types, the name of this element should ultimately
+ change</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>repository</td>
+ <td>The name of the repository in which this module resides.</td>
+ <td>Yes.</td>
+ </tr>
+ <tr>
+ <td>host-prefix</td>
+ <td>Additional information which will be added in the front of the
+ host name. Useful for repositories like sorceforge which define
+ a separate virtual host for every project</td>
+ <td>No.</td>
+ </tr>
+ <tr>
+ <td>dir</td>
+ <td>The subdirectory in which the cvs module is present. Useful
+ for repositories like developerworks which organize related modules
+ into directories.</td>
+ <td>No.</td>
+ </tr>
+ <tr>
+ <td>module</td>
+ <td>An override for the name of the cvs module.</td>
+ <td>No. Defaults to the name of the repository.</td>
+ </tr>
+ </table>
</subsection>
<subsection name="project">
- <p></p>
+ <p>A definition of a <a href="project.html">project</a> which is
+ physically contained in this module.</p>
</subsection>
</section>
</body>
1.2 +41 -7 jakarta-alexandria/proposal/gump/site/xdocs/overview.xml
Index: overview.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/overview.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- overview.xml 2001/09/25 02:30:35 1.1
+++ overview.xml 2001/09/25 05:22:27 1.2
@@ -23,13 +23,13 @@
overriding of a target and the adding of a dependency.</p>
<p>An area for future exploration is "anti-elements", which cancel out
- the effect of other elements</p>
+ the effect of other elements</p>
<p>An area where designers of XML DTDs have differing opinions is whether
a given piece of information should be modelled as an attribute or an
- element. A design goal of Gump was to try to reinvent as little as
+ element. A design goal of Gump was to try to reinvent as little as
possible - resulting in a bit of inconsistency. Project definitions are
- done in a style reminicent of Ant - with element and attribute names
+ done in a style reminicent of Ant - with element and attribute names
chosen to match whenever possible. Repository definitions were done in
a style consistent with Alexandria. In a few cases, information can
be represented as either a nested element or an attribute - this was
@@ -40,19 +40,53 @@
descriptions</p>
<subsection name="project">
- <p></p>
+ <p>A <a href="project.html">project</a> represents the unit of
+ integration for Gump. It could represent a buildable project, or an
+ installable package. Its primary roles are to be a target of a
+ dependency or the provider of jars and/or other source files.</p>
+
+ <p>In the case of buildable projects, project definitions contain
+ values for properties and the dependencies are used to construct
+ the classpath.</p>
+
+ <p>Note the project definitions contain the names of the jar or
+ jars that they export. Consuming projects simply name the projects
+ that they depend on.</p>
</subsection>
<subsection name="module">
- <p></p>
+ <p>A <a href="module.html">module</a> is a collection of projects that
+ are physically stored in a single repository. Due to the way that Gump
+ will combine definitions, a module definition can be spread across
+ multiple files.</p>
+
+ <p>While a module references a repository, it can also contain prefixes
+ and suffixes that modify the value of the CVSROOT used.</p>
+ </subsection>
+
+ <subsection name="repository">
+ <p>A <a href="repository.html">repository</a> specifies where modules
+ can physically be located. In the case of cvs (the only option
+ supported at the present time), it contains the information used to
+ form the CVSROOT used on checkout and update commands.</p>
</subsection>
<subsection name="profile">
- <p></p>
+ <p>A <a href="profile.html">profile</a> is a collection of projects and
+ repositories that are logically to be considered a unit. A profile can
+ provide a consistent set of installable dependencies, or tagged versions
+ of cvs modules to be used.</p>
</subsection>
<subsection name="workspace">
- <p></p>
+ <p>A <a href="workspace.html">workspace</a> defines the ultimate
+ word as to what projects and repositories are to be used, and the
+ options (e.g., properties, tags, targets, and dependencies) are to
+ be used to build.</p>
+
+ <p>A workspace definition should also be the only place where
+ absolute path names and other machine specific information is
+ contained.</p>
</subsection>
</section>
1.2 +60 -4 jakarta-alexandria/proposal/gump/site/xdocs/profile.xml
Index: profile.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/profile.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- profile.xml 2001/09/25 02:30:35 1.1
+++ profile.xml 2001/09/25 05:22:27 1.2
@@ -9,18 +9,74 @@
<body>
<section name="profile">
- <p>TBD</p>
+ <p>A profile is a collection of projects and repositories that are
+ logically to be considered a unit. A profile can provide a consistent set
+ of installable dependencies, or tagged versions of cvs modules to be used.
+ </p>
<subsection name="module">
- <p></p>
+ <p>An individual module to be included. While a complete
+ module can be defined here, typically one is referenced via
+ href. For a complete description, see the documentation for
+ <a href="module.html">module</a>.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>href</td>
+ <td>URI of the file containing the module definition</td>
+ <td>Yes.</td>
+ </tr>
+ </table>
</subsection>
<subsection name="project">
- <p></p>
+ <p>An individual project to be extended. For a complete description,
+ see the documentation for <a href="project.html">project</a>.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>Name of the project to be modified</td>
+ <td>Yes.</td>
+ </tr>
+ <tr>
+ <td>package</td>
+ <td>Specifies the name of the subdirectory relative to the pkgdir
+ specified in the workspace definition.
+ </td>
+ <td>No.</td>
+ </tr>
+ </table>
</subsection>
<subsection name="repository">
- <p></p>
+ <p>An repository to be included. While a complete repository can be
+ defined here, typically one is referenced via href. For a complete
+ description, see the documentation for
+ <a href="repository.html">repository</a>.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>href</td>
+ <td>URI of the file containing the repository definition</td>
+ <td>Yes.</td>
+ </tr>
+ </table>
</subsection>
</section>
1.2 +15 -15 jakarta-alexandria/proposal/gump/site/xdocs/workspace.xml
Index: workspace.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/workspace.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- workspace.xml 2001/09/25 02:30:35 1.1
+++ workspace.xml 2001/09/25 05:22:27 1.2
@@ -9,7 +9,7 @@
<body>
<section name="Workspace">
- <p>This represents the combination of projects (either referenced
+ <p>This represents the combination of projects (either referenced
directly or indirectly, via profiles) that are to be built together.
By default, workspaces are named after the hostname of the computer
which you are building on.</p>
@@ -21,7 +21,7 @@
<th>Required?</th>
</tr>
<tr>
- <td>Basedir</td>
+ <td>basedir</td>
<td>Fully qualified directory into which all projects will be
extracted built.
</td>
@@ -39,7 +39,7 @@
<td>cvsdir</td>
<td>Workarea for cvs extracts. The generated update script will
do the cvs checkouts or updates into this directory. The generated
- build script will copy the results into the basedir prior to
+ build script will copy the results into the basedir prior to
building.
</td>
<td>No. Defaults to ${basedir}/cvs</td>
@@ -99,7 +99,7 @@
<tr>
<td>href</td>
<td>URI of the file containing the profile definition</td>
- <td>No.</td>
+ <td>Yes.</td>
</tr>
</table>
</subsection>
@@ -119,7 +119,7 @@
<tr>
<td>href</td>
<td>URI of the file containing the module definition</td>
- <td>No.</td>
+ <td>Yes.</td>
</tr>
</table>
</subsection>
@@ -137,13 +137,13 @@
<th>Required?</th>
</tr>
<tr>
- <td>href</td>
- <td>URI of the file containing the project definition</td>
- <td>No.</td>
+ <td>name</td>
+ <td>Name of the project to be modified</td>
+ <td>Yes.</td>
</tr>
<tr>
<td>home</td>
- <td>Convenient way to specify an override for a root/home
+ <td>Convenient way to specify an override for a root/home
element.
</td>
<td>No.</td>
@@ -153,8 +153,8 @@
<subsection name="repository">
<p>An repository from which one or more modules may be obtained
- While a complete repository can be defined here, typically one is
- referenced via href. For a complete description, see the documentation
+ While a complete repository can be defined here, typically one is
+ referenced via href. For a complete description, see the documentation
for <a href="repository.html">repository</a>.</p>
<table>
@@ -166,25 +166,25 @@
<tr>
<td>href</td>
<td>URI of the file containing the repository definition</td>
- <td>No.</td>
+ <td>Yes.</td>
</tr>
<tr>
<td>method</td>
- <td>Convenient way to specify an override for a root/method
+ <td>Convenient way to specify an override for a root/method
element
</td>
<td>No.</td>
</tr>
<tr>
<td>user</td>
- <td>Convenient way to specify an override for a root/user
+ <td>Convenient way to specify an override for a root/user
element
</td>
<td>No.</td>
</tr>
<tr>
<td>path</td>
- <td>Convenient way to specify an override for a root/path
+ <td>Convenient way to specify an override for a root/path
element
</td>
<td>No.</td>
1.3 +2 -2
jakarta-alexandria/proposal/gump/site/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file:
/home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/stylesheets/project.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.xml 2001/09/25 02:30:35 1.2
+++ project.xml 2001/09/25 05:22:28 1.3
@@ -23,12 +23,12 @@
href="/workspace.html"/>
<item name="profile"
href="/profile.html"/>
+ <item name="repository"
+ href="/repository.html"/>
<item name="module"
href="/module.html"/>
<item name="project"
href="/project.html"/>
- <item name="repository"
- href="/repository.html"/>
</menu>
<menu name="Sources">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
