chemistry-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gabri...@apache.org
Subject svn commit: r1076725 - /chemistry/site/trunk/content/java/opencmis-how-to-build.mdtext
Date Thu, 03 Mar 2011 19:02:34 GMT
Author: gabriele
Date: Thu Mar  3 19:02:34 2011
New Revision: 1076725

URL: http://svn.apache.org/viewvc?rev=1076725&view=rev
Log:
updated how to get to javadocs 

Modified:
    chemistry/site/trunk/content/java/opencmis-how-to-build.mdtext

Modified: chemistry/site/trunk/content/java/opencmis-how-to-build.mdtext
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/java/opencmis-how-to-build.mdtext?rev=1076725&r1=1076724&r2=1076725&view=diff
==============================================================================
--- chemistry/site/trunk/content/java/opencmis-how-to-build.mdtext (original)
+++ chemistry/site/trunk/content/java/opencmis-how-to-build.mdtext Thu Mar  3 19:02:34 2011
@@ -1,13 +1,15 @@
 Title: OpenCMIS how-to-build
 Breadcrumb: opencmis:OpenCMIS
 
+[TOC]
+
 # How to build OpenCMIS
 <a name="OpenCMIShow-to-build-HowtobuildOpenCMIS"></a>
 
 OpenCMIS releases are available [here](opencmis.html).
 If you want to build the latest and greatest instead, follow these simple steps:
 
-* Make sure you have JDK 1.5 or higher, Maven 2.2 and a Subversion client installed. <br/>(The
CMIS Workbench requires JDK 1.6!)
+* Make sure you have JDK 1.5 or higher, Maven 2.2.1 and a Subversion client installed. <br/>(The
CMIS Workbench requires JDK 1.6!)
 * Fetch the source code via Subversion from here: [https://svn.apache.org/repos/asf/chemistry/opencmis/trunk](https://svn.apache.org/repos/asf/chemistry/opencmis/trunk)
 * And finally run:
 
@@ -15,6 +17,13 @@ If you want to build the latest and grea
 
     mvn clean install -Dmaven.test.skip=true
 
+* To produce also commodity packages (ZIPs and Tarballs), source and javadoc JARs run:
+
+&nbsp;
+
+    mvn clean install -Papache-release
+
+
 
 <a name="OpenCMIShow-to-build-TheClientLibraries"></a>
 ## The Client Libraries
@@ -33,14 +42,38 @@ Please refer to the [Server Framework](o
 
 
 <a name="OpenCMIShow-to-build-BuildJavaDoc"></a>
-## Build JavaDoc
 
-There is not much OpenCMIS documentation available, yet. This pages and the
-JavaDoc are the major sources for information. The JavaDoc can be build by
-running:
+## JavaDocs
+
+### Releases Javadocs
+
+You can access OpenCMIS releases Javadocs in the following ways:
+
+ 1. Every release publishes an online Javadoc version
+ 2. Javadocs are included in the `chemistry-opencmis-docs.zip` and `chemistry-opencmis-docs.tar.gz`
+packages for offline browsing
+
+
+To browse online Javadocs for latest/older releases check the [home page][1]'s Download section.
+
+
+### Latest Javadocs 
+
+You can access OpenCMIS latest (trunk) Javadocs in the following ways:
+
+ 1. Build them from trunk using Maven
+ 
+* Checkout the [project trunk][2] 
+* Run `mvn site` or `mvn javadoc:aggregate`
+* Open `./target/site/apidocs/index.html`
 
+ 2.Access the latest CI Javadoc 
+ 
+* (**TODO**) <del>Latest Javadocs for current SNAPSHOT version (trunk) are produced
by our build server 
+and available [here][3]</del>
 
-    mvn javadoc:aggregate
 
 
-The JavaDoc will be created in `/target/site/apidocs`.
+  [1]: http://chemistry.apache.org/java/opencmis.html
+  [2]: http://svn.apache.org/repos/asf/chemistry/opencmis/trunk/
+  [3]: http://chemistry.apache.org/java/maven/apidocs/index.html
\ No newline at end of file



Mime
View raw message