You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2012/01/30 19:56:09 UTC

svn commit: r1237927 - in /uima/site/trunk/uima-website: docs/building-uima.html xdocs/building-uima.xml

Author: schor
Date: Mon Jan 30 18:56:08 2012
New Revision: 1237927

URL: http://svn.apache.org/viewvc?rev=1237927&view=rev
Log:
no Jira - slight corrections of build instructions, and spelling fixes

Modified:
    uima/site/trunk/uima-website/docs/building-uima.html
    uima/site/trunk/uima-website/xdocs/building-uima.xml

Modified: uima/site/trunk/uima-website/docs/building-uima.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/building-uima.html?rev=1237927&r1=1237926&r2=1237927&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/building-uima.html (original)
+++ uima/site/trunk/uima-website/docs/building-uima.html Mon Jan 30 18:56:08 2012
@@ -239,7 +239,7 @@
     you can use the <code>repo-browser</code> right-click menu option to do this.</p>
     </li>
     <li><p>
-      <code>cd to c:\myWorkingDirectoryForUimaj\uimaj</code> or <br />
+      <code>cd to c:\myWorkingDirectoryForUimaj\</code> or <br />
       <code>cd to c:\myWorkingDirectoryForUima-as\uima-as</code>.</p>
     </li>
     <li><p><code>mvn install</code></p>
@@ -263,11 +263,7 @@
     also are put into your local Maven repository.  
     Docbook output is placed in each project's target/site/d directory.
   </p>
-                                                <p>For multi-module projects (e.g. uimaj and uima-as), there is a module named
-     uimaj-distr or uima-as-distr, which contains the binary distribution build result.
-     You may want to retrieve the "lib" directory containing the built Jars; to do this,
-     go to the xxx-distr/target directory and unzip/untar the binary artifact - in that
-     you will find the lib directory.
+                                                <p>Multi-module builds create the build artifacts (including the binary assembly) in the <code>target</code> folder of their top level project.
   </p>
                             </blockquote>
         </td></tr>
@@ -289,8 +285,8 @@
       Eclipse menu: <code>File -&gt; Import -&gt; Maven -&gt; Existing Maven projects</code>
       to import the project or projects (for multi-module projects) into an Eclipse workspace 
       and set them up for Maven building.</li>
-    <li>To run maven commands on a project from within Eclipse, select the project, right click, and pick <code>Run as</code>
-      and then select mvn install (or other choice as you wish).</li>
+    <li>To run Maven commands on a project from within Eclipse, select the project, right click, and pick <code>Run as</code>
+      and then select <code>mvn install</code> (or other choice as you wish).</li>
   </ol>
                                                 <p class="note"><big><b>Help! I'm getting compile errors (class not found) in Eclipse!</b></big>  
     If your Maven build generates sources (e.g., you have some XMLBeans defined), 
@@ -337,7 +333,7 @@
       <tr><td>
         <blockquote class="subsectionBody">
                                     <p>The PDF docbook generation defaults to a paper type of USletter.  You may override this
-  by specifying the maven property "pdfPaperType".  You may specify this on the command line
+  by specifying the Maven property "pdfPaperType".  You may specify this on the command line
   as follows:
   <code>mvn -DpdfPaperType=A4 package</code>
   </p>
@@ -364,8 +360,8 @@
 (Note: this kludgy procedure needs improvement)
 </p>
                                                 <p>
-If you get a failure messsage, the details of the failures are logged in a file 
-for each project which has a failue, in the folder target/surefire-reports.  
+If you get a failure message, the details of the failures are logged in a file 
+for each project which has a failure, in the folder target/surefire-reports.  
 In Eclipse, you can use the Search facility to search Files in the workspace of type "*.txt" 
 for the string "&lt;&lt;&lt; FAILURE!" to locate all the failure messages.
 </p>

Modified: uima/site/trunk/uima-website/xdocs/building-uima.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/building-uima.xml?rev=1237927&r1=1237926&r2=1237927&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/building-uima.xml (original)
+++ uima/site/trunk/uima-website/xdocs/building-uima.xml Mon Jan 30 18:56:08 2012
@@ -73,7 +73,7 @@ under the License.
     you can use the <code>repo-browser</code> right-click menu option to do this.</p>
     </li>
     <li><p>
-      <code>cd to c:\myWorkingDirectoryForUimaj\uimaj</code> or <br/>
+      <code>cd to c:\myWorkingDirectoryForUimaj\</code> or <br/>
       <code>cd to c:\myWorkingDirectoryForUima-as\uima-as</code>.</p>
     </li>
     <li><p><code>mvn install</code></p>
@@ -98,11 +98,7 @@ under the License.
     also are put into your local Maven repository.  
     Docbook output is placed in each project's target/site/d directory.
   </p>
-  <p>For multi-module projects (e.g. uimaj and uima-as), there is a module named
-     uimaj-distr or uima-as-distr, which contains the binary distribution build result.
-     You may want to retrieve the "lib" directory containing the built Jars; to do this,
-     go to the xxx-distr/target directory and unzip/untar the binary artifact - in that
-     you will find the lib directory.
+  <p>Multi-module builds create the build artifacts (including the binary assembly) in the <code>target</code> folder of their top level project.
   </p>
 </subsection>  
 
@@ -127,8 +123,8 @@ under the License.
       Eclipse menu: <code>File -> Import -> Maven -> Existing Maven projects</code>
       to import the project or projects (for multi-module projects) into an Eclipse workspace 
       and set them up for Maven building.</li>
-    <li>To run maven commands on a project from within Eclipse, select the project, right click, and pick <code>Run as</code>
-      and then select mvn install (or other choice as you wish).</li>
+    <li>To run Maven commands on a project from within Eclipse, select the project, right click, and pick <code>Run as</code>
+      and then select <code>mvn install</code> (or other choice as you wish).</li>
   </ol>
   
   <p class="note"><big><b>Help! I'm getting compile errors (class not found) in Eclipse!</b></big>  
@@ -154,7 +150,7 @@ under the License.
 
   <subsection name="Creating A4-size PDF documentation" id="building.docbooks.a4">
   <p>The PDF docbook generation defaults to a paper type of USletter.  You may override this
-  by specifying the maven property "pdfPaperType".  You may specify this on the command line
+  by specifying the Maven property "pdfPaperType".  You may specify this on the command line
   as follows:
   <code>mvn -DpdfPaperType=A4 package</code>
   </p>
@@ -213,8 +209,8 @@ under the License.
 (Note: this kludgy procedure needs improvement)
 </p>
 <p>
-If you get a failure messsage, the details of the failures are logged in a file 
-for each project which has a failue, in the folder target/surefire-reports.  
+If you get a failure message, the details of the failures are logged in a file 
+for each project which has a failure, in the folder target/surefire-reports.  
 In Eclipse, you can use the Search facility to search Files in the workspace of type "*.txt" 
 for the string "&lt;&lt;&lt; FAILURE!" to locate all the failure messages.
 </p>