[Openfast-commit] SF.net SVN: openfast:[301] trunk

[<ope...@li...>]

Revision: 301
          http://openfast.svn.sourceforge.net/openfast/?rev=301&view=rev
Author:   jacob_northey
Date:     2013-03-11 16:30:50 +0000 (Mon, 11 Mar 2013)
Log Message:
-----------
[FAST-46] Added javadoc generation to site-deploy; Added information on releasing next version to README; Added disclaimer to main page on using 1.1.1 or 1.1.2

Modified Paths:
--------------
    trunk/README
    trunk/pom.xml
    trunk/src/site/xdoc/index.xml.vm

Modified: trunk/README
===================================================================
--- trunk/README	2013-03-05 14:55:15 UTC (rev 300)
+++ trunk/README	2013-03-11 16:30:50 UTC (rev 301)
@@ -26,4 +26,13 @@
   SourceForge has new restricted shell access.  To release or deploy OpenFAST, use the following steps:
   For more information see http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3/examples/site-deploy-to-sourceforge.net.html
    1. ssh -t jac...@sh... create
-   2. mvn deploy
\ No newline at end of file
+   2. mvn deploy
+   
+Releasing
+=========
+  1. Check that you can successfully deploy OpenFAST by following the steps in the [Deploying] section.
+  2. Make sure all local changes are checked in.
+  3. Run the release:prepare goal and follow the steps to set the release version.
+  > mvn release:prepare
+  4. Run the release:perform goal to finalize the release.
+  5. Check http://www.openfast.org to verify that the new version information is on the website.
\ No newline at end of file

Modified: trunk/pom.xml
===================================================================
--- trunk/pom.xml	2013-03-05 14:55:15 UTC (rev 300)
+++ trunk/pom.xml	2013-03-11 16:30:50 UTC (rev 301)
@@ -224,6 +224,20 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <links>
+                        <link>http://commons.apache.org/lang/api</link>
+                        <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
+                    </links>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
 
     <distributionManagement>
         <repository>

Modified: trunk/src/site/xdoc/index.xml.vm
===================================================================
--- trunk/src/site/xdoc/index.xml.vm	2013-03-05 14:55:15 UTC (rev 300)
+++ trunk/src/site/xdoc/index.xml.vm	2013-03-11 16:30:50 UTC (rev 301)
@@ -27,6 +27,13 @@
 		  </ul>
 		</div>
 		<section name="OpenFAST">
+			<subsection name="Implementation Details">
+			   <b>IMPORTANT:</b>
+			   <ul>
+			   <li>OpenFAST 1.1.1: the <a href="apidocs/org/openfast/MessageInputStream.html#readMessage()">MessageInputStream.readMessage()</a> method will throw a <a href="apidocs/org/openfast/error/FastException.html">FastException</a> when the end of the stream is encountered.</li>
+			   <li>OpenFAST 1.1.2:  the <a href="apidocs/org/openfast/MessageInputStream.html#readMessage()">MessageInputStream.readMessage()</a> method will throw a <a href="apidocs/org/openfast/error/FastException.html">FastException</a> when the end of the stream is encountered in the middle of decoding a message.  If the end of the stream is encountered immediately after reading a full message, null is returned.</li>
+			   </ul>
+			</subsection>
 			<subsection name="What is OpenFAST?">	
 				OpenFAST is a 100% Java implementation of the FAST Protocol (FIX Adapted for STreaming). 
 				The FAST protocol is used to optimize communications in the electronic exchange of financial data. 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.