commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject svn commit: r230972 - /jakarta/commons/proper/commons-build/trunk/xdocs/building.xml
Date Tue, 09 Aug 2005 05:31:03 GMT
Author: psteitz
Date: Mon Aug  8 22:31:01 2005
New Revision: 230972

URL: http://svn.apache.org/viewcvs?rev=230972&view=rev
Log:
Eliminated *here* links.

Modified:
    jakarta/commons/proper/commons-build/trunk/xdocs/building.xml

Modified: jakarta/commons/proper/commons-build/trunk/xdocs/building.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/commons-build/trunk/xdocs/building.xml?rev=230972&r1=230971&r2=230972&view=diff
==============================================================================
--- jakarta/commons/proper/commons-build/trunk/xdocs/building.xml (original)
+++ jakarta/commons/proper/commons-build/trunk/xdocs/building.xml Mon Aug  8 22:31:01 2005
@@ -58,19 +58,20 @@
     </p>
     <subsection name='Getting and installing maven'>
       <p>
-      Follow the instructions 
-      <a href="http://maven.apache.org/start/download.html">here</a> to
-      download and install maven. Be sure to follow the instructions for
-      upgrading the plugins to the latest releases.
+      Follow the 
+      <a href="http://maven.apache.org/start/download.html">
+      maven download instructions</a> to download and install maven. Be sure
+      to follow the instructions for upgrading the plugins to the latest
+      releases.
       </p>
     </subsection>
     <subsection name='Checking out the commons sources'>
       <p>
-      Follow the instructions 
-      <a href="http://jakarta.apache.org/commons/svninfo.html">here</a> to
-      check out the commons source files. If you want to build
-      commons component web sites, you need to have the 
-      <code>commons-build</code> module checked out as a peer to whatever 
+      Follow the 
+      <a href="http://jakarta.apache.org/commons/svninfo.html">
+      commons subversion instructions</a> to check out the commons source
+      files. If you want to build commons component web sites, you need to have
+      the <code>commons-build</code> module checked out as a peer to whatever

       component(s) you are trying to generate the site for. If you check out
       the full set of "trunks" using the svn externals "trunks-proper" or
       "trunks-sandbox" this will happen automatically.
@@ -82,14 +83,14 @@
       in <code>project.xml</code> or <code>project.properties</code>)
should be
       avoided. There are a few things, however, that are specific to individual
       developers that may need to be set locally. Generally, only committers
-      need to set local properties.  As documented
-      <a href="http://maven.apache.org/reference/properties.html">here</a>, 
-      maven looks for property values first in <code>project.properties</code>
-      in the project's base directory (where <code>project.xml</code>
-      lives), then in <code>build.properties</code> if that exists in the
-      same directory, then in ${user.home}/build.properties and finally in
-      System properties. Values are successively overridden if they occur in
-      multiple places in this list.
+      need to set local properties.  As documented in the
+      <a href="http://maven.apache.org/reference/properties.html">
+      maven properties reference</a>, maven looks for property values first in
+      <code>project.properties</code> in the project's base directory (where
+      <code>project.xml</code> lives), then in <code>build.properties</code>
if
+      that exists in the same directory, then in ${user.home}/build.properties
+      and finally in System properties. Values are successively overridden if
+      they occur in multiple places in this list.
       </p>
       <p>
       It may be convenient for committers running unix systems to set the
@@ -98,7 +99,7 @@
       <pre>
       maven.username (apache user name, for site deployment)
       maven.repo.apache.releases.username   (apache user name, for releases)
-      maven.repo.apache.releases.privatekey (pgp signing key)
+      maven.repo.apache.releases.privatekey (path to pgp signing key)
       </pre>
       If you work only on Jakarta projects, you can add
       <code> maven.remote.group=jakarta </code>
@@ -110,11 +111,10 @@
 
   <section name='Maven POM (project.xml) configuration'>
   <p>
-  A sample <code>project.xml</code> file showing the standard configuration
-  for Jakarta Commons components can be found 
+  This section describes the key elements in the maven POM and how the 
   <a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/commons-build/trunk/project.xml.sample">
-  here</a> This section describes the key elements in the POM and how the
-  sample file needs to be modified or customized for different components.
+  sample <code>project.xml</code></a> file needs to be modified or customized
+  for different components.
   </p> 
     <subsection name='Top level elements'>
       <p>
@@ -165,7 +165,7 @@
       these distinctions apply.</td></tr>
       <tr><td>build</td><td>The sample file assumes the standard
directory
       layout, with source code in <code>src/jave</code> and tests in 
-      <code>src/test</code>.  It also assumes that test classes have names that
+      <code>src/test</code>. It also assumes that test classes have names that
       end in "Test", e.g. "FooManagerTest.java" and that abstract test classes
       have names that end in "AbstractTest", e.g., "FooFooerAbstractTest." Do
       <strong>not</strong> remove the <code>resources</code> element
that
@@ -174,22 +174,22 @@
       limited to the short list in the sample POM.  The 
       <code>maven-changes-plugin</code> should only be used if the component
       maintains a <code>changes.xml</code> file in <code>/xdocs</code>

-      following the format described 
-      <a href="http://maven.apache.org/reference/plugins/changes/">here</a>
-      </td></tr></table>
+      following the format described in the
+      <a href="http://maven.apache.org/reference/plugins/changes/">
+      maven changes plugin documentation</a></td></tr></table>
       </p>
     </subsection>
   </section>
 
   <section name='Property configuration'>
     <p>
-    A sample <code>project.properties</code> can be found 
+    There is very little that needs to be customized for individual components
+    in the
     <a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/commons-build/trunk/project.properties.sample">
-    here</a> There is very little that needs to be customized for individual
-    components in this file. The table below calls out a few
-    properties which individual components may wish to modify.  The deployment
-    and site generation properties (which should not be changed) are discussed
-    in other sections below.
+    sample <code>project.properties</code> file</a>. The table below calls
out
+    a few properties which individual components may wish to modify.  The
+    deployment and site generation properties (which should not be changed) are
+    discussed in other sections below.
     <table><tr><th>Property</th><th>Comments</th></tr>
     <tr><td>maven.test.skip</td><td>Set to <code>true</code>
to skip unit tests
     during build. Useful when testing build changes, but should not be checked
@@ -210,10 +210,9 @@
     <p>
     Use <code>maven site:generate</code> to generate the component web site
     locally. Then review the generated html in <code>target/docs.</code>
-    Navigation is specified in <code>xdocs/navigation.xml.</code> A sample
-    navigation file can be found 
+    Navigation is specified in <code>xdocs/navigation.xml.</code> The
     <a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/commons-build/trunk/navigation.xml.sample">
-    here.</a>  This file refers to entities defined in 
+    sample navigation file</a> refers to entities defined in 
     <code>../../commons-build/menus/menus.dtd,</code> so, as mentioned above,
     commons-build has to be checked out as a peer to the component whose web
     site you are building. The menu structure in the sample is standard for
@@ -239,8 +238,8 @@
     <li> You have to be a member of the <code>jakarta</code> unix group

     (should happen when you are set up as a jakarta committer).</li>
     <li> You have an ssh key set up. Follow the instructions at the bottom
-    of <a href="http://www.apache.org/dev/cvs-on-unix.html">this page</a>
-    to get this set up correctly.</li></ol>
+    of the <a href="http://www.apache.org/dev/cvs-on-unix.html">
+    apache cvs info page</a> to get this set up correctly.</li></ol>
     Assuming the second condition above is met, you can also deploy sites
     manually using scp or by tarring / zipping and extracting the content
     to the path above on <code>cvs.apache.org.</code>  In either case,



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message