commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r922467 - in /commons/proper/commons-site/src/site/xdoc: building-m1.xml building.xml commons-parent-pom.xml releases/prepare.xml releases/release.xml
Date Sat, 13 Mar 2010 02:20:10 GMT
Author: sebb
Date: Sat Mar 13 02:20:10 2010
New Revision: 922467

URL: http://svn.apache.org/viewvc?rev=922467&view=rev
Log:
Capitalise Ant, Maven, Apache where used as proper noun

Modified:
    commons/proper/commons-site/src/site/xdoc/building-m1.xml
    commons/proper/commons-site/src/site/xdoc/building.xml
    commons/proper/commons-site/src/site/xdoc/commons-parent-pom.xml
    commons/proper/commons-site/src/site/xdoc/releases/prepare.xml
    commons/proper/commons-site/src/site/xdoc/releases/release.xml

Modified: commons/proper/commons-site/src/site/xdoc/building-m1.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/building-m1.xml?rev=922467&r1=922466&r2=922467&view=diff
==============================================================================
--- commons/proper/commons-site/src/site/xdoc/building-m1.xml (original)
+++ commons/proper/commons-site/src/site/xdoc/building-m1.xml Sat Mar 13 02:20:10 2010
@@ -36,12 +36,12 @@
     </p>
     <p>
     The assumption throughout is that we are working with a component named
-    "Apache Commons Foo" that uses maven as its build system, both for
+    "Apache Commons Foo" that uses Maven as its build system, both for
     distribution binaries and for the web site.  Contributions of instructions
-    covering ant-based builds are welcome! 
+    covering Ant-based builds are welcome! 
     </p>
     <p>
-    Some knowledge of maven is assumed in this document.  Please refer to the
+    Some knowledge of Maven is assumed in this document.  Please refer to the
     <a href="http://maven.apache.org/maven-1.x/using/index.html">maven user guide</a>
and
     <a href="http://maven.apache.org/maven-1.x/reference/index.html">reference</a>
     for more information. This document is concerned with using version 1 of maven.
@@ -51,16 +51,16 @@
 
   <section name='Local environment setup'>
     <p>
-    To build Apache Commons components or web sites, you need to have maven
+    To build Apache Commons components or web sites, you need to have Maven
     installed and the project source files checked out locally. You may also
     need to have some local build properties specified.  This section describes
     the local setup required. 
     </p>
-    <subsection name='Getting and installing maven'>
+    <subsection name='Getting and installing Maven'>
       <p>
       Follow the 
       <a href="http://maven.apache.org/maven-1.x/start/download.html">
-      maven download instructions</a> to download and install maven. You will
+      Maven download instructions</a> to download and install Maven. You will
       need Maven version 1.0.2.
       </p>
       <p>
@@ -99,7 +99,7 @@
       developers that may need to be set locally. Generally, only committers
       need to set local properties.  As documented in the
       <a href="http://maven.apache.org/maven-1.x/reference/properties.html">
-      maven properties reference</a>, maven looks for property values first in
+      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
@@ -109,23 +109,23 @@
       <p>
       It may be convenient for committers to set the
       following properties in ${user.home}/build.properties, which will make
-      them apply to all maven projects that they work on.
+      them apply to all Maven projects that they work on.
       <pre>
-      maven.username (apache user name, for site deployment)
-      maven.repo.apache.releases.username   (apache user name, for releases)
+      maven.username (Apache user name, for site deployment)
+      maven.repo.apache.releases.username   (Apache user name, for releases)
       maven.repo.apache.releases.privatekey (path to pgp signing key)
       </pre>
       If you work only on Commons projects, you can add
       <code> maven.remote.group=commons </code>
       otherwise this will need to be specified for each project that you want
-      to use maven to deploy.
+      to use Maven to deploy.
       </p>
     </subsection> 
   </section>
 
   <section name='Maven POM (project.xml) configuration'>
   <p>
-  This section describes the key elements in the maven POM and how the 
+  This section describes the key elements in the Maven POM and how the 
   <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build/trunk/samples/project.xml.sample">
   sample <code>project.xml</code></a> file needs to be modified or customized
   for different components.
@@ -174,7 +174,7 @@
       should include adding him/herself to the developers list.</td></tr>
       <tr><td>contributors</td><td>Most commons components have done
away with
       @author tags, so the way we acknowledge contributors is by adding them to
-      this list, which will appear on the maven-generated web site. Make sure
+      this list, which will appear on the Maven-generated web site. Make sure
       that you have the correct spelling of contributors' names and do not
       include email addresses unless contributors specifically authorize this.
       </td></tr>
@@ -194,7 +194,7 @@
       maintains a <code>changes.xml</code> file in <code>/xdocs</code>

       following the format described in the
       <a href="http://maven.apache.org/maven-1.x/plugins/changes/">
-      maven changes plugin documentation</a></td></tr></table>
+      Maven changes plugin documentation</a></td></tr></table>
       </p>
     </subsection>
   </section>
@@ -257,7 +257,7 @@
     (should happen when you are set up as a commons committer).</li>
     <li> You have an ssh key set up. Follow the instructions on the
     <a href="http://www.apache.org/dev/user-ssh.html">
-    apache SSH Access page</a> to get this set up correctly.</li></ol>
+    Apache SSH Access 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>people.apache.org.</code>  In either case,
@@ -271,30 +271,30 @@
   <section name='Deploying jars'>
     <p>
     Maven's jar plugin supports automated deployment of jars to local or remote
-    maven repositories.  This powerful feature makes distribution easy, but
+    Maven repositories.  This powerful feature makes distribution easy, but
     also makes inadvertent deployment of development jars possible. The
     setup in 
     <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build/trunk/samples/project.properties.sample">
     <code>project.properties.sample</code></a> ensures that this does not
-    happen.  This section explains how to deploy jars using maven at apache.
+    happen.  This section explains how to deploy jars using Maven at apache.
     </p>
     <subsection name='Repository structure'>
       <p>
-      There are three maven repositories that apache committers should be aware
+      There are three Maven repositories that Apache committers should be aware
       of.  The table below describes each of these repositories.
       <table><tr><th>External Repository URL</th><th>Function</th></tr>
       <tr><td>http://people.apache.org/repository/</td>
-      <td>deployment location for apache "snapshot" jars. This repository
-      exists for internal apache use only. External projects should
+      <td>deployment location for Apache "snapshot" jars. This repository
+      exists for internal Apache use only. External projects should
       <strong>not</strong> use this repository for dependency resolution and
-      apache projects should <strong>not</strong> release code with dependencies
on
+      Apache projects should <strong>not</strong> release code with dependencies
on
       snapshot jars.</td></tr>
       <tr><td>http://www.apache.org/dist/java-repository/</td>
-      <td>deployment location for <strong>released</strong> apache jars.

-      Should not be accessed for dependency resolution by maven builds. Contents
+      <td>deployment location for <strong>released</strong> Apache jars.

+      Should not be accessed for dependency resolution by Maven builds. Contents
       are rsynced to ibiblio.</td></tr>
       <tr><td>http://www.ibiblio.org/maven/</td>
-      <td>Default remote repository used by maven. Apache release jars are
+      <td>Default remote repository used by Maven. Apache release jars are
       rsynced every few hours from java-repository to this repository.</td></tr>
       </table>
       </p>
@@ -339,7 +339,7 @@
       Assuming the setup in <code>project.properties.sample</code>, and 
       correctly set currectVersion (should end in
       <code>-SNAPSHOT</code>) the following command can be used to deploy a 
-      "snapshot" or "development build" jar to the apache snapshot repository:
+      "snapshot" or "development build" jar to the Apache snapshot repository:
       <source>maven jar:deploy-snapshot</source>
       </p>
     </subsection>

Modified: commons/proper/commons-site/src/site/xdoc/building.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/building.xml?rev=922467&r1=922466&r2=922467&view=diff
==============================================================================
--- commons/proper/commons-site/src/site/xdoc/building.xml (original)
+++ commons/proper/commons-site/src/site/xdoc/building.xml Sat Mar 13 02:20:10 2010
@@ -36,28 +36,28 @@
     </p>
     <p>
     The assumption throughout is that we are working with a component named
-    "Apache Commons Foo" that uses maven as its build system, both for
+    "Apache Commons Foo" that uses Maven as its build system, both for
     distribution binaries and for the web site.
     </p>
     <p>
-    Some knowledge of maven is assumed in this document.  Please refer to the
-    <a href="http://maven.apache.org/guides/">maven user guide</a>
-    for more information. Most commons components now use version 2 of maven,
-    so this is the maven version assumed throughout this document.
+    Some knowledge of Maven is assumed in this document.  Please refer to the
+    <a href="http://maven.apache.org/guides/">Maven user guide</a>
+    for more information. Most commons components now use version 2 of Maven,
+    so this is the Maven version assumed throughout this document.
     See <a href="building-m1.html">here</a> for Maven 1 details.
     </p>
   </section>
 
   <section name='Local environment setup'>
     <p>
-    To build Apache Commons components or web sites, you need to have maven
+    To build Apache Commons components or web sites, you need to have Maven
     installed and the project source files checked out locally.
     </p>
-    <subsection name='Getting and installing maven'>
+    <subsection name='Getting and installing Maven'>
       <p>
       Follow the 
       <a href="http://maven.apache.org/download.html">
-      maven download instructions</a> to download and install maven.
+      Maven download instructions</a> to download and install Maven.
       </p>
     </subsection>
     <subsection name='Checking out the commons sources'>

Modified: commons/proper/commons-site/src/site/xdoc/commons-parent-pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/commons-parent-pom.xml?rev=922467&r1=922466&r2=922467&view=diff
==============================================================================
--- commons/proper/commons-site/src/site/xdoc/commons-parent-pom.xml (original)
+++ commons/proper/commons-site/src/site/xdoc/commons-parent-pom.xml Sat Mar 13 02:20:10 2010
@@ -155,7 +155,7 @@
           <li>
             <strong>Common Information</strong>
             <ul>
-              <li><strong>Mailing Lists</strong> - Mailing list information
is specified in commons-parent and maven automatically
+              <li><strong>Mailing Lists</strong> - Mailing list information
is specified in commons-parent and Maven automatically
                   generates a standard <a href="mail-lists.html">Mailing List page</a>
for each compoenent.</li>
               <li><strong>Organization Name</strong> - <i>The Apache
Software Foundation</i> (inherited from the Apache Parent pom).</li>
             </ul>
@@ -393,7 +393,7 @@
         <p>
           <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/pom.xml">commons-parent</a>
           contains a <code>trunks-proper</code> profile with the <a href="components.html">components</a>
set up
-          as <code>&lt;modules&gt;</code>. This is a <i>convenience</i>
profile so that maven commands can be run
+          as <code>&lt;modules&gt;</code>. This is a <i>convenience</i>
profile so that Maven commands can be run
           for all <a href="components.html">components</a>.
         </p>
 
@@ -417,7 +417,7 @@
         <p>
           <a href="http://svn.apache.org/repos/asf/commons/proper/commons-sandbox-parent/trunk/pom.xml">commons-sandbox-parent</a>
           contains a <code>trunks-sandbox</code> profile with the <a href="sandbox/index.html">sandbox
components</a> set up
-          as <code>&lt;modules&gt;</code>. This is a <i>convenience</i>
profile so that maven commands can be run
+          as <code>&lt;modules&gt;</code>. This is a <i>convenience</i>
profile so that Maven commands can be run
           for all <a href="sandbox/index.html">sandbox components</a>.
         </p>
 

Modified: commons/proper/commons-site/src/site/xdoc/releases/prepare.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/releases/prepare.xml?rev=922467&r1=922466&r2=922467&view=diff
==============================================================================
--- commons/proper/commons-site/src/site/xdoc/releases/prepare.xml (original)
+++ commons/proper/commons-site/src/site/xdoc/releases/prepare.xml Sat Mar 13 02:20:10 2010
@@ -129,7 +129,7 @@
     that the current level of compatibility is suitable for the proposed version number.
     Check the current level of compatibility in the code. Tools like 
     <a href='http://clirr.sourceforge.net'>Clirr</a> and 
-    <a href='http://www.jdiff.org'>JDiff</a> are very useful. Both support ant
and maven.
+    <a href='http://www.jdiff.org'>JDiff</a> are very useful. Both support Ant
and Maven.
     	</p>
     </subsection>
     <subsection name='Check Javadocs And Code Style'>
@@ -154,13 +154,13 @@
     on that JVM. 
         </p>
         <p> 
-    If using maven 1, the <code>maven.compile.target</code> property in the 
+    If using Maven 1, the <code>maven.compile.target</code> property in the 
     <code>project.properties</code> file should be set correctly.
-    If using ant, the <code>javac</code> task should have the <code>target</code>
+    If using Ant, the <code>javac</code> task should have the <code>target</code>
     attribute set correctly.
         </p>
         <p>
-    The maven 1 build now adds entries to the jar's manifest to show the values
+    The Maven 1 build now adds entries to the jar's manifest to show the values
     of the <code>maven.compile.source</code> and <code>maven.compile.target</code>
     properties used to generate the jar. For more details on this see sections
     <a href="#checkjarmanifest">Check The Jar Manifest</a> and 
@@ -175,14 +175,14 @@
     <subsection name='Check Documentation'>
         <p>
     Check that the documentation has been generated correctly. Check that all links are working.
-    Those using maven can use the 
+    Those using Maven can use the 
     <a href='http://maven.apache.org/maven-1.x/plugins/linkcheck/'>LinkCheck plugin</a>
report
     to automate this check.
         </p>
     </subsection>
     <subsection name='(Maven Only) Consider Naming Of Source Distribution'>
         <p>
-    By default, maven uses the same directory name for both binary and source distributions
+    By default, Maven uses the same directory name for both binary and source distributions
     (commons-foo-1.2). Some find it more convenient to have the source distribution unpack
     to commons-foo-1.2-src. This can be done easily by adding the following line to the
     component's project.properties file:
@@ -219,7 +219,7 @@
         configured, any MANIFEST.MF file present within the project will simply be ignored.
         </p>
         <p>
-        The maven build has been modified to include two <strong><i>non standard</i></strong>
attributes
+        The Maven build has been modified to include two <strong><i>non standard</i></strong>
attributes
         in the jar's manifest to indicate the <code>maven.compile.source</code>
and 
         <code>maven.compile.target</code> properties used to create the jar.
This serves two purposes:
           <ul>
@@ -253,8 +253,8 @@
         If you are using Ant to build the release, then the MANIFEST.MF file at foo/src/conf/MANIFEST.MF
         should contain appropriate <code>@varname@</code> strings which are replaced
dynamically 
         by an Ant copy task
-        using values defined in the ant build.xml file. If the component's MANIFEST.MF file
instead 
-        has hard-wires values then it should be fixed to use appropriate ant variables. Useful
reference
+        using values defined in the Ant build.xml file. If the component's MANIFEST.MF file
instead 
+        has hard-wires values then it should be fixed to use appropriate Ant variables. Useful
reference
         documents are:
         </p>
         <ul>
@@ -473,7 +473,7 @@ The release notes should contain the min
         The NOTICE.txt must be distributed along with the LICENSE.txt.
         Check that the distribution build correct adds this file
         to the distributions.
-        Those using maven may need to add some scripting to the maven.xml.
+        Those using Maven may need to add some scripting to the maven.xml.
         For example:
         </p>
         <pre>
@@ -494,7 +494,7 @@ The release notes should contain the min
         </pre>
         <p>
         Check that the jar contains a copy of the NOTICE.txt in the META-INF directory.
-        Those using maven may need to add NOTICE.txt to the build resources section
+        Those using Maven may need to add NOTICE.txt to the build resources section
         of the project.xml. For example:
         </p>
         <pre>
@@ -599,7 +599,7 @@ The release notes should contain the min
         </pre>
         </p>
 	<p>
-	The reports generated by maven (Clover, jCoverage, etc) are very useful things to inspect
in this
+	The reports generated by Maven (Clover, jCoverage, etc) are very useful things to inspect
in this
 	website.
 	</p>
 	<p>
@@ -730,7 +730,7 @@ The release notes should contain the min
     </p>
     <p><strong>Maven Build</strong></p>
     <p>
-    The maven build has been modified to include two <strong><i>non standard</i></strong>
attributes
+    The Maven build has been modified to include two <strong><i>non standard</i></strong>
attributes
     in the jar's manifest to indicate the <code>maven.compile.source</code> and

     <code>maven.compile.target</code> properties used to create the jar. This
serves two purposes:
       <ul>
@@ -756,7 +756,7 @@ The release notes should contain the min
     </p>
     <p>
     Maven 2 builds default to including this, so no further effort is required
-    for those projects. To make sure that this file is included in maven 1-generated <i>jars</i>,
+    for those projects. To make sure that this file is included in Maven 1-generated <i>jars</i>,
     include the following in the build section of your project.xml (or just add the
     resource defined below to the build resources you already have).
     </p>
@@ -775,7 +775,7 @@ The release notes should contain the min
     </pre>
     <p>
     To make sure that this file is included in the top-level directory of source and binary
-    distribution files (zips and tars), define preGoals for maven's dist goal that copy
+    distribution files (zips and tars), define preGoals for Maven's dist goal that copy
     NOTICE.txt to the source and binary assembly directories that it uses to package the
     release. To do this, add the snippet below to maven.xml.
     </p>

Modified: commons/proper/commons-site/src/site/xdoc/releases/release.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/releases/release.xml?rev=922467&r1=922466&r2=922467&view=diff
==============================================================================
--- commons/proper/commons-site/src/site/xdoc/releases/release.xml (original)
+++ commons/proper/commons-site/src/site/xdoc/releases/release.xml Sat Mar 13 02:20:10 2010
@@ -232,7 +232,7 @@ gpg: Good signature from "Robert Burrell
         <li>all the release distributions</li>
         <li>the detached signature files (<code>.asc</code>) for these
releases</li>
         <li>the md5 sums (<code>.md5</code>) for these releases</li>
-        <li>the release notes. (If you're using maven, you may need to create a stripped
down plain text
+        <li>the release notes. (If you're using Maven, you may need to create a stripped
down plain text
         version.)</li>
     </ul>
     </p>
@@ -357,7 +357,7 @@ gpg: Good signature from "Robert Burrell
   <subsection name='8 Deploy Maven Artifacts to Java-Repository'>
     <p>
     The ASF Java Respository is the home for distributions in jar format.
-    Your maven artifacts (jar and  pom, files) should be placed in 
+    Your Maven artifacts (jar and  pom, files) should be placed in 
     <code>/www/people.apache.org/repo/m2-ibiblio-rsync-repository/commons-foo/commons-foo/1.2/</code>
     on people.apache.org.
     </p>
@@ -377,7 +377,7 @@ gpg: Good signature from "Robert Burrell
 
   <subsection name='9 Test Main Site Downloads'>
     <p>
-    You should now be able to get the new release from the main apache web site 
+    You should now be able to get the new release from the main Apache web site 
     (<code>http://www.apache.org/dist/commons/foo/</code>). 
     </p>
     <p>
@@ -478,7 +478,7 @@ gpg: Good signature from "Robert Burrell
     <p>
     Please remember to give a brief description of you component. Please also remember to
remind people 
     about verifying the signatures. The subject should be something like <code>[ANNOUNCEMENT]
Foo 1.2 Released</code>. 
-    Send this mail from your apache account. Please spell check the document!
+    Send this mail from your Apache account. Please spell check the document!
     </p>
     <p>
     This should go to (at least) the following mailing lists:



Mime
View raw message