sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1505630 - in /sis/branches/JDK7: ./ application/sis-webapp/ core/sis-build-helper/src/site/apt/ core/sis-referencing/src/main/java/org/apache/sis/geometry/ core/sis-utility/src/main/java/org/apache/sis/setup/ src/site/apt/
Date Mon, 22 Jul 2013 08:52:40 GMT
Author: desruisseaux
Date: Mon Jul 22 08:52:40 2013
New Revision: 1505630

URL: http://svn.apache.org/r1505630
Log:
Miscellaneous documentation fixes (wording, spelling and formatting).

Modified:
    sis/branches/JDK7/application/sis-webapp/pom.xml
    sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/setup/About.java
    sis/branches/JDK7/pom.xml
    sis/branches/JDK7/src/site/apt/release-process.apt
    sis/branches/JDK7/src/site/apt/release-setup.apt

Modified: sis/branches/JDK7/application/sis-webapp/pom.xml
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/application/sis-webapp/pom.xml?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/application/sis-webapp/pom.xml (original)
+++ sis/branches/JDK7/application/sis-webapp/pom.xml Mon Jul 22 08:52:40 2013
@@ -47,8 +47,8 @@
       <artifactId>georss-rome</artifactId>
       <version>0.9.8</version>
       <!-- We have to specify the version here because georss-rome is intentionally excluded
from
-           the dependency management of the root pom.xml. The problem is that the artefact
filename
-           is "georss-rome", but the <artefactId> element in its pom.xml declares "georss"
without
+           the dependency management of the root pom.xml. The problem is that the artifact
filename
+           is "georss-rome", but the <artifactId> element in its pom.xml declares "georss"
without
            the "-rome" suffix, which causes some environments to complain about this inconsistency.
            Omitting the declaration from the root pom.xml limits the inconvenience to this
"sis-webapp"
            module only. -->

Modified: sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt [UTF-8] Mon Jul 22 08:52:40
2013
@@ -123,7 +123,7 @@ Building Apache SIS
     so execution of this plugin should be very cheap and consume few disk space.
 
   * Dependencies already present in the <<<target/binaries>>> directory
are presumed stables and
-    are not overwritten. Only artefacts produced by the Maven build are unconditionally overwritten.
+    are not overwritten. Only artifacts produced by the Maven build are unconditionally overwritten.
 
   This plugin can be activated by the following fragment in the parent <<<pom.xml>>>
file:
 

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] Mon Jul 22 08:52:40 2013
@@ -113,7 +113,7 @@ public final class Envelopes extends Sta
      * parsed} by the {@code GeneralEnvelope} constructor.
      *
      * @param  envelope The envelope to format.
-     * @return The envelope as a {@code BOX} or {@code BOX3D} in WKT format.
+     * @return This envelope as a {@code BOX} or {@code BOX3D} (most typical dimensions)
element.
      *
      * @see #fromWKT(CharSequence)
      * @see org.apache.sis.io.wkt

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/setup/About.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/setup/About.java?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/setup/About.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/setup/About.java [UTF-8]
Mon Jul 22 08:52:40 2013
@@ -534,7 +534,7 @@ pathTree:   for (int j=0; ; j++) {
 
     /**
      * If a file path in the given node or any children follow the Maven pattern, remove
the
-     * artefact name and version numbers redundancies in order to make the name more compact.
+     * artifact name and version numbers redundancies in order to make the name more compact.
      * For example this method replaces {@code "org/opengis/geoapi/3.0.0/geoapi-3.0.0.jar"}
      * by {@code "org/opengis/(…)/geoapi-3.0.0.jar"}.
      */

Modified: sis/branches/JDK7/pom.xml
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/pom.xml?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/pom.xml (original)
+++ sis/branches/JDK7/pom.xml Mon Jul 22 08:52:40 2013
@@ -683,7 +683,7 @@ Apache SIS is a free software, Java lang
   <!-- ==============================================================
          Additional repositories from which to download artifacts.
          The parent pom.xml already declares the apache.snapshots
-         repository for library artefacts. But we also need it for
+         repository for library artifacts. But we also need it for
          Maven plugins in order to download sis-build-helper when
          the user did not built it himself.
        ============================================================== -->

Modified: sis/branches/JDK7/src/site/apt/release-process.apt
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/src/site/apt/release-process.apt?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/src/site/apt/release-process.apt [UTF-8] (original)
+++ sis/branches/JDK7/src/site/apt/release-process.apt [UTF-8] Mon Jul 22 08:52:40 2013
@@ -149,7 +149,7 @@ svn commit --message "Prepare the branch
   before to fix the problem and try again.
 
 -----------------------------------------------------------------------------------------------------
-mvn release:prepare --define releaseVersion=$NEW_VERSION --define tag=$NEW_VERSION \\
+mvn release:prepare --define releaseVersion=$NEW_VERSION --define tag=$NEW_VERSION \
     --define autoVersionSubmodules=true --define updateWorkingCopyVersions=false --define
dryRun=true
 -----------------------------------------------------------------------------------------------------
 
@@ -172,9 +172,9 @@ eval $(gpg-agent --daemon)
   The only things that should be different between these files are the <<<<version>>>>
and <<<<scm>>>> elements.
   Comparisons can be performed for all files with the following command:
 
-----------------------------------------------------------
-find . -name "pom.xml" -print -exec diff '{}' '{}'.tag \\;
-----------------------------------------------------------
+---------------------------------------------------------
+find . -name "pom.xml" -print -exec diff '{}' '{}'.tag \;
+---------------------------------------------------------
 
   View the <<<release.properties>>> file and check for the following properties:
 
@@ -186,9 +186,9 @@ find . -name "pom.xml" -print -exec diff
 
   Verify signature for all files:
 
-----------------------------------------------------
-find . -name "sis-*.asc" -exec gpg --verify '{}' \\;
-----------------------------------------------------
+---------------------------------------------------
+find . -name "sis-*.asc" -exec gpg --verify '{}' \;
+---------------------------------------------------
 
   Clean and ensure that there is no modified files, i.e. that the last <<<svn>>>
command produces no output:
 
@@ -199,16 +199,16 @@ svn status
 
 
 
-* Perform the release
+* Deploy the release
 
   Run the <<<release:prepare>>> goal for real this time. The command is
identical to the one in the
   <Create a branch> section except for the <<<dryRun>>> property,
which is omitted.
   This command will create the tag and commit the changes on SVN.
 
--------------------------------------------------------------------------------------
-mvn release:prepare --define releaseVersion=$NEW_VERSION --define tag=$NEW_VERSION \\
+------------------------------------------------------------------------------------
+mvn release:prepare --define releaseVersion=$NEW_VERSION --define tag=$NEW_VERSION \
     --define autoVersionSubmodules=true --define updateWorkingCopyVersions=false
--------------------------------------------------------------------------------------
+------------------------------------------------------------------------------------
 
   In theory, the next command would be <<<mvn release:perform>>>.
   However in fact, that command only checks out the project from tag folder and then run
the <<<deploy>>> phase.

Modified: sis/branches/JDK7/src/site/apt/release-setup.apt
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/src/site/apt/release-setup.apt?rev=1505630&r1=1505629&r2=1505630&view=diff
==============================================================================
--- sis/branches/JDK7/src/site/apt/release-setup.apt [UTF-8] (original)
+++ sis/branches/JDK7/src/site/apt/release-setup.apt [UTF-8] Mon Jul 22 08:52:40 2013
@@ -33,7 +33,7 @@ One time release management setup
 * Shell configuration
 
   It is better for Unix shells to contain the following line in their initialization file
-  (typically {{~/.bashrc}} or {{~/.profile}}, where {{~}} stands for the user's home directory):
+  (typically {{\~/.bashrc}} or {{\~/.profile}}, where {{\~}} stands for the user's home directory):
 
 ---------------------
 export GPG_TTY=$(tty)
@@ -48,7 +48,7 @@ export GPG_TTY=$(tty)
   The {{{http://www.apache.org/dev/openpgp.html}OpenPGP instructions}} list out detailed
steps on managing your keys.
   The following steps provide a summary:
 
-  Edit the <<<~/.gnupg/gpg.conf>>> configuration file (where <<<~>>>
is the home directory) and add the following
+  Edit the <<<\~/.gnupg/gpg.conf>>> configuration file (where <<<\~>>>
is the home directory) and add the following
   configuration options, or edit the existing values if any:
 
 -------------------------------------------------------------------------------------------------------
@@ -122,7 +122,7 @@ gpg --send-key <key_id>
 * Maven Configuration & Nexus Setup
 
   Detailed instructions are at {{{http://www.apache.org/dev/publishing-maven-artifacts.html}Publishing
Maven Artifacts}}.
-  In summary, the developer needs to specify username, and optionally password, in his local
<<<~/.m2>>> directory.
+  In summary, the developer needs to specify username, and optionally password, in his local
<<<\~/.m2>>> directory.
   If not already done, create a Maven master password:
 
 ----------------------------------------
@@ -130,7 +130,7 @@ mvn --encrypt-master-password <password>
 ----------------------------------------
 
   The command will produce an encrypted version of the given password, something like <<<\{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=\}>>>.
-  Store this password in the <<<~/.m2/settings-security.xml>>> file like
below:
+  Store this password in the <<<\~/.m2/settings-security.xml>>> file like
below:
 
 +---------------------------------------------------------------+
 <settingsSecurity>
@@ -145,7 +145,7 @@ mvn --encrypt-password <passphrase>
 -----------------------------------
 
   The command will produce an encrypted version of the passphrase, something like <<<\{COQLCE6DU6GtcS5P=\}>>>.
-  Cut-and-paste it in a section of the <<<~/.m2/settings.xml>>> file like
below:
+  Cut-and-paste it in a section of the <<<\~/.m2/settings.xml>>> file like
below:
 
 +--------------------------------------------------------------------+
 <settings>



Mime
View raw message