Author: bayard
Date: Tue Jun 12 12:16:17 2007
New Revision: 546604

URL: http://svn.apache.org/viewvc?view=rev&rev=546604
Log:
Improving release notes so they discuss the backwards compatibility issues

Added:
    jakarta/commons/proper/cli/trunk/xdocs/upgrading-1.0-to-1.1.xml   (with 
props)
Modified:
    jakarta/commons/proper/cli/trunk/xdocs/index.xml
    jakarta/commons/proper/cli/trunk/xdocs/navigation.xml

Modified: jakarta/commons/proper/cli/trunk/xdocs/index.xml
URL: 
http://svn.apache.org/viewvc/jakarta/commons/proper/cli/trunk/xdocs/index.xml?view=diff&rev=546604&r1=546603&r2=546604
==============================================================================
--- jakarta/commons/proper/cli/trunk/xdocs/index.xml (original)
+++ jakarta/commons/proper/cli/trunk/xdocs/index.xml Tue Jun 12 12:16:17 2007
@@ -68,7 +68,7 @@
 <p>
 The latest version is v1.1. - 
 <a 
href="http://jakarta.apache.org/site/downloads/downloads_commons-cli.cgi";>Download
 now!</a><br />
-The <a href="changes-report.html#1_1">release notes</a> are also available.
+The <a href="upgrading-1.0-to-1.1.html">release notes</a> are also available.
 </p>
 <p>
 For previous releases, see the <a 
href="http://archive.apache.org/dist/jakarta/commons/cli/";>Apache Archive</a>

Modified: jakarta/commons/proper/cli/trunk/xdocs/navigation.xml
URL: 
http://svn.apache.org/viewvc/jakarta/commons/proper/cli/trunk/xdocs/navigation.xml?view=diff&rev=546604&r1=546603&r2=546604
==============================================================================
--- jakarta/commons/proper/cli/trunk/xdocs/navigation.xml (original)
+++ jakarta/commons/proper/cli/trunk/xdocs/navigation.xml Tue Jun 12 12:16:17 
2007
@@ -36,6 +36,7 @@
       <item name="Getting started"          href="/introduction.html"/>
       <item name="Usage scenarios"   href="/usage.html"/>
       <item name="Option properties" href="/properties.html"/>
+      <item name="Upgrading to 1.1" href="/upgrading-1.0-to-1.1.html"/>
       <item name="Javadoc (1.1)" href="api-release/index.html"/>
     </menu>
 

Added: jakarta/commons/proper/cli/trunk/xdocs/upgrading-1.0-to-1.1.xml
URL: 
http://svn.apache.org/viewvc/jakarta/commons/proper/cli/trunk/xdocs/upgrading-1.0-to-1.1.xml?view=auto&rev=546604
==============================================================================
--- jakarta/commons/proper/cli/trunk/xdocs/upgrading-1.0-to-1.1.xml (added)
+++ jakarta/commons/proper/cli/trunk/xdocs/upgrading-1.0-to-1.1.xml Tue Jun 12 
12:16:17 2007
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<document>
+ <properties>
+  <title>Upgrading from 1.0 to 1.1</title>
+  <author email="commons-dev@jakarta.apache.org">Commons Documentation 
Team</author>
+ </properties>
+<body>
+<!-- ================================================== -->
+<section name="Upgrading from 1.0 to 1.1">
+  <p>CLI 1.1 is a bugfix release of CLI. The following changes were not 
backward compatible: </p>
+
+  <ul>
+    <li>The CommandLineParser interface has two additional methods. If you 
were extending this,
+        then you will need to add methods to your classes. If you were 
extending the abstract
+        Parser class, then you should be okay. </li>
+    <li>The HelpFormatter class had publicly accessible fields. These are now 
accessed via
+        get/set methods. </li>
+    <li>Two of HelpFormatter's methods no longer throw 
IllegalArgumentException. </li>
+    <li>The Option class is no longer cloneable, and no longer has an 
addValue(String) method. </li>
+  </ul>
+
+  <p>The best way to test any of the above is to recompile your code against 
CLI 1.1. All of the above 
+      should result in compile time errors. </p>
+</section>
+<section name="Bugs fixed in 1.1">
+  <p>The list of bugs fixed in 1.1 may be seen via the 
+    <a href="changes-report.html#1_1">changes report</a>. </p>
+</section>
+<!-- ================================================== -->
+</body>
+</document>

Propchange: jakarta/commons/proper/cli/trunk/xdocs/upgrading-1.0-to-1.1.xml
------------------------------------------------------------------------------
    svn:eol-style = native



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to