commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ebo...@apache.org
Subject svn commit: r681071 - in /commons/proper/cli/trunk: src/site/site.xml xdocs/changes.xml xdocs/download_cli.xml xdocs/index.xml xdocs/introduction.xml xdocs/navigation.xml xdocs/properties.xml xdocs/release_1_0.xml xdocs/release_1_2.xml xdocs/usage.xml
Date Wed, 30 Jul 2008 14:53:30 GMT
Author: ebourg
Date: Wed Jul 30 07:53:29 2008
New Revision: 681071

URL: http://svn.apache.org/viewvc?rev=681071&view=rev
Log:
Updated the site for CLI 1.2
Changed the main page to include a more detailed presentation of the component
Removed the redundant pages (navigation.xml and cvs-usage.xml)

Added:
    commons/proper/cli/trunk/xdocs/release_1_2.xml   (with props)
Removed:
    commons/proper/cli/trunk/xdocs/navigation.xml
Modified:
    commons/proper/cli/trunk/src/site/site.xml
    commons/proper/cli/trunk/xdocs/changes.xml
    commons/proper/cli/trunk/xdocs/download_cli.xml
    commons/proper/cli/trunk/xdocs/index.xml
    commons/proper/cli/trunk/xdocs/introduction.xml
    commons/proper/cli/trunk/xdocs/properties.xml
    commons/proper/cli/trunk/xdocs/release_1_0.xml
    commons/proper/cli/trunk/xdocs/usage.xml

Modified: commons/proper/cli/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/site/site.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/src/site/site.xml (original)
+++ commons/proper/cli/trunk/src/site/site.xml Wed Jul 30 07:53:29 2008
@@ -15,7 +15,7 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-<project name="CLI">
+<project name="Commons CLI">
     <bannerRight>
         <name>Commons CLI</name>
         <src>/images/logo.png</src>
@@ -23,7 +23,7 @@
     </bannerRight>
 
     <body>
-        <menu name="CLI">
+        <menu name="Commons CLI">
             <item name="Overview"             href="/index.html"/>
             <item name="Download"             href="http://commons.apache.org/downloads/download_cli.cgi"/>
             <item name="Changes Report"       href="/changes-report.html"/>
@@ -32,15 +32,14 @@
             <item name="Source Repository"    href="/source-repository.html"/>
         </menu>
 
-        <menu name="CLI1 user guide">
+        <menu name="CLI 1 User Guide">
             <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"/>
+            <item name="Javadoc (1.2)"        href="api-release/index.html"/>
         </menu>
 
-        <menu name="CLI2-dev user guide">
+        <menu name="CLI 2 User Guide (dev)">
             <item name="Overview"             href="/manual/index.html"/>
             <item name="Examples"             href="/examples/index.html"/>
             <item name="Options"              href="/manual/options.html"/>

Modified: commons/proper/cli/trunk/xdocs/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/changes.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/changes.xml (original)
+++ commons/proper/cli/trunk/xdocs/changes.xml Wed Jul 30 07:53:29 2008
@@ -24,8 +24,8 @@
 
     <release version="1.2" date="in SVN" description="This is a maintenance release containing
bug fixes.">
       <action type="fix" dev="ebourg" issue="CLI-137">
-        The number of arguments defined for an option specifies the arguments per occurence
of the option
-        and not for all occurences. This was a major regression in CLI 1.1 which prevented
the use of repeated options.
+        The number of arguments defined for an option specifies the arguments per occurrence
of the option
+        and not for all occurrences. This was a major regression in CLI 1.1 which prevented
the use of repeated options.
       </action>
       <action type="add" dev="ebourg">
         Added a getOptionProperties() method in the CommandLine class to retrieve easily
the key/value pairs

Modified: commons/proper/cli/trunk/xdocs/download_cli.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/download_cli.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/download_cli.xml (original)
+++ commons/proper/cli/trunk/xdocs/download_cli.xml Wed Jul 30 07:53:29 2008
@@ -102,17 +102,17 @@
         <ul class="downloads">
           <li class="group"><div class="links"><span class="label">Binary</span></div>
             <ul>
-              <li class="download"><a href="[preferred]/commons/cli/binaries/commons-cli-1.1.tar.gz">1.1.tar.gz</a>
+              <li class="download"><a href="[preferred]/commons/cli/binaries/commons-cli-1.2.tar.gz">1.2.tar.gz</a>
                 <ul class="attributes">
-                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.1.tar.gz.md5">md5</a>]</span>
-                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.1.tar.gz.asc">pgp</a>]</span>
+                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.2.tar.gz.md5">md5</a>]</span>
+                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.2.tar.gz.asc">pgp</a>]</span>
                   </li>
                 </ul>
               </li>
-              <li class="download"><a href="[preferred]/commons/cli/binaries/commons-cli-1.1.zip">1.1.zip</a>
+              <li class="download"><a href="[preferred]/commons/cli/binaries/commons-cli-1.2.zip">1.2.zip</a>
                 <ul class="attributes">
-                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.1.zip.md5">md5</a>]</span>
-                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.1.zip.asc">pgp</a>]</span>
+                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.2.zip.md5">md5</a>]</span>
+                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.2.zip.asc">pgp</a>]</span>
                   </li>
                 </ul>
               </li>
@@ -120,17 +120,17 @@
           </li>
           <li class="group"><div class="links"><span class="label">Source</span></div>
             <ul>
-              <li class="download"><a href="[preferred]/commons/cli/source/commons-cli-1.1-src.tar.gz">1.1.tar.gz</a>
+              <li class="download"><a href="[preferred]/commons/cli/source/commons-cli-1.2-src.tar.gz">1.2.tar.gz</a>
                 <ul class="attributes">
-                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.1-src.tar.gz.md5">md5</a>]</span>
-                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.1-src.tar.gz.asc">pgp</a>]</span>
+                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.2-src.tar.gz.md5">md5</a>]</span>
+                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.2-src.tar.gz.asc">pgp</a>]</span>
                   </li>
                 </ul>
               </li>
-              <li class="download"><a href="[preferred]/commons/cli/source/commons-cli-1.1-src.zip">1.1.zip</a>
+              <li class="download"><a href="[preferred]/commons/cli/source/commons-cli-1.2-src.zip">1.2.zip</a>
                 <ul class="attributes">
-                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.1-src.zip.md5">md5</a>]</span>
-                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.1-src.zip.asc">pgp</a>]</span>
+                  <li><span class="md5">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.2-src.zip.md5">md5</a>]</span>
+                      <span class="pgp">[<a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.2-src.zip.asc">pgp</a>]</span>
                   </li>
                 </ul>
               </li>

Modified: commons/proper/cli/trunk/xdocs/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/index.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/index.xml (original)
+++ commons/proper/cli/trunk/xdocs/index.xml Wed Jul 30 07:53:29 2008
@@ -19,147 +19,173 @@
 -->
 <document>
 
- <properties>
+  <properties>
     <title>Home</title>
     <author email="dev@commons.apache.org">commons-dev</author>
- </properties>
+  </properties>
 
   <body>
-<!-- ================================================== -->
-<section name="Commons CLI">
-<p>
-The Apache Commons CLI library provides an API for processing command line interfaces.
-</p>
-</section>
-<!-- ================================================== -->
-<section name="1.x vs 2.x?">
-<p>
-Commons CLI 1.0 was formed from the merger of ideas and code from three different libraries
-
-Werken, Avalon and Optz. In dealing with the bugs and the feature requests a freshly designed
and not backwards compatible 
-CLI 2.0 was created, but never finished or released. Since then a CLI 1.1 bugfix release
has been made.
-</p>
-<p>
-There are currently no plans to continue the 1.x line beyond bugfixes. The 2.x design is
generally preferred and is in use, 
-however there is no current activity to make a 2.0 release. To this end, the 1.1 release
is recommended to most users 
-while the 2.x line is recommended for anyone interested in helping to get this better API
released. 
-</p>
-</section>
-<!-- ================================================== -->
-<section name="Documentation">
-<p>
-A full <a href="introduction.html">User's Guide</a> is available
-as are various <a href="maven-reports.html">project reports</a>.
-</p>
-<p>
-The JavaDoc API documents are available online:
-</p>
-<ul>
-<li>The <a href="api-release/index.html">current release 1.1</a></li>
-<li>The <a href="api-1.0/index.html">previous version 1.0</a></li>
-<li>The <a href="apidocs/index.html">latest SVN (2.0-SNAPSHOT)</a></li>
-</ul>
-<p>
-The <a href="cvs-usage.html">subversion repository</a> can be
-<a href="http://svn.apache.org/viewvc/commons/proper/cli/trunk/">browsed</a>.
-</p>
-</section>
-<!-- ================================================== -->
-<section name="Releases">
-<p>
-The latest version is v1.1. - 
-<a href="http://commons.apache.org/downloads/download_cli.cgi">Download now!</a><br
/>
-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/commons/cli/">Apache
Archive</a>
-</p>
-</section>
-<!-- ================================================== -->
-<section name="Support">
-<p>
-The <a href="mail-lists.html">commons mailing lists</a> act as the main support
forum.
-The user list is suitable for most library usage queries.
-The dev list is intended for the development discussion.
-Please remember that the lists are shared between all commons components,
-so prefix your email by [cli].
-</p>
-<p>
-Issues may be reported via the <a href="issue-tracking.html">ASF JIRA</a>.
-</p>
-</section>
-<!-- ================================================== -->
-
-<!--      <p>
-        CLI1 was formed by the merger of ideas and code from three different
-        libraries and allows most simple interfaces to be modelled.  CLI1
-        became increasingly difficult to maintain and develop further and so
-        CLI2 has been developed with the goals of clearer responsibilities and
-        being more flexible.  The intention is that CLI2 should be able to
-        model a far greater selection of interfaces and do so more completely,
-        validating as much as possible.
-      </p>
-      <p>
-        The redesigned CLI2 is rooted in the <code>org.apache.commons.cli2</code>
-        package and the distribution retains the <code>org.apache.commons.cli</code>
-        package so that the upgrade doesn't break old code.  The CLI1 package
-        should be regarded as deprecated to encourage the transition to the
-        more flexible CLI2 framework but minor bug fixes and patches may be
-        accepted to ensure that CLI1 based applications continue to function as
-        expected.
-      </p>
-      <p>
-        The rest of the documentation is split into the following three sections:
-        <ul>
-          <li><a href="manual/index.html">CLI2</a> - a reference manual
for version 2</li>
-          <li><a href="introduction.html">CLI1</a> - documentation for
version 1 </li>
-          <li><a href="examples/index.html">Examples</a> - a selection
of worked examples demonstrating CLI2 features</li>
-        </ul>
-      </p>
-      <p>
-        The latest version of this documentation is available on the web:
-        <ul>
-          <li><a href="http://commons.apache.org/cli/">http://commons.apache.org/cli/</a></li>
-          <li>
-            <a href="http://commons.apache.org/cli/commons-cli.pdf">http://commons.apache.org/cli/commons-cli.pdf</a>

-            <a href="http://commons.apache.org/cli/commons-cli.pdf"><img border="0"
src="images/pdf.gif"/></a> 
-          </li>
-        </ul>
+    <section name="Commons CLI">
+      <p>
+        The Apache Commons CLI library provides an API for parsing command line options passed
to programs.
+        It's also able to print help messages detailing the options available for a command
line tool.
+      </p>
+      <p>
+        Commons CLI supports different types of options:
+      </p>
+      <ul>
+        <li>POSIX like options (ie. <code>tar -zxvf foo.tar.gz</code>)</li>
+        <li>GNU like long options (ie. <code>du --human-readable --max-depth=1</code>)</li>
+        <li>Java like properties (ie. <code>java -Djava.awt.headless=true -Djava.net.useSystemProxies=true
Foo</code>)</li>
+        <li>Short options with value attached (ie. <code>gcc -O2 foo.c</code>)</li>
+        <li>long options with single hyphen (ie. <code>ant -projecthelp</code>)</li>
+      </ul>
+      <p>
+        A typical help message displayed by Commons CLI looks like this:
+      </p>
+      <source>
+usage: ls
+ -A,--almost-all          do not list implied . and ..
+ -a,--all                 do not hide entries starting with .
+ -B,--ignore-backups      do not list implied entried ending with ~
+ -b,--escape              print octal escapes for nongraphic characters
+    --block-size &lt;SIZE>   use SIZE-byte blocks
+ -c                       with -lt: sort by, and show, ctime (time of last
+                          modification of file status information) with
+                          -l:show ctime and sort by name otherwise: sort
+                          by ctime
+ -C                       list entries by columns
+      </source>
+      <p>
+        Check out the <a href="introduction.html">introduction</a> page for a
detailed presentation.
+      </p>
+    </section>
+
+    <section name="1.x vs 2.x?">
+      <p>Commons CLI 1.0 was formed from the merger of ideas and code from three different
libraries -
+      Werken, Avalon and Optz. In dealing with the bugs and the feature requests a freshly
designed and not
+      backwards compatible CLI 2 was created, but never finished or released. Since then
bugfix releases
+      have been made for CLI 1.</p>
+
+      <p>The current plan is to maintain the 1.x line until CLI 2 is officially released.
The 2.x design is generally
+      preferred and is in use, however there is no current activity to make a 2.0 release.
To this end, the 1.2
+      release is recommended to most users while the 2.x line is recommended for anyone interested
in helping to get
+      this better API released.</p>
+    </section>
+
+    <section name="Documentation">
+      <p>
+        A full <a href="introduction.html">User's Guide</a> is available
+        as are various<a href="maven-reports.html">project reports</a>.
+      </p>
+      <p>
+        The Javadoc API documents are available online:
+      </p>
+      <ul>
+        <li><a href="api-release/index.html">CLI 1.2 (current release)</a></li>
+        <li><a href="api-1.1/index.html">CLI 1.1</a></li>
+        <li><a href="api-1.0/index.html">CLI 1.0</a></li>
+        <li><a href="apidocs/index.html">CLI 2.0-SNAPSHOT (latest SVN)</a></li>
+      </ul>
+      <p>
+        The <a href="source-repository.html">Subversion repository</a> can be
+        <a href="http://svn.apache.org/viewvc/commons/proper/cli/trunk/">browsed</a>.
       </p>
     </section>
-    <section name="Dependancies">
+
+    <section name="Releases">
+      <p>
+        The latest version is v1.2. -
+        <a href="http://commons.apache.org/downloads/download_cli.cgi">Download now!</a>
+        <br/>
+        The <a href="release_1_2.html">release notes</a> are also available.
+      </p>
       <p>
-        The generated list of <a href="dependencies.html">dependencies</a> 
-        lists the libraries needed to compile and test Commons CLI.  To use 
-        the precompiled distribution none of these dependancies are strictly 
-        necessary.  The following is a breakdown of what is required and when:
-      </p>
-      <table>
-        <tr>
-          <th>Library</th><th>Usage</th>
-        </tr>
-        <tr>
-          <td>Java 1.2</td>
-          <td>This is the minimum java level needed to use CLI2</td>
-        </tr>
-        <tr>
-          <td>Java 1.4</td>
-          <td>Needed if the PreferencesCommandLine is needed</td>
-        </tr>
-        <tr>
-          <td>commons-lang</td>
-          <td>Needed if the CLI1 package is being used</td>
-        </tr>
-        <tr>
-          <td>jdepend</td>
-          <td>Needed to build and test CLI2 only</td>
-        </tr>
-        <tr>
-          <td>junit</td>
-          <td>Needed to build and test CLI1 and CLI2</td>
-        </tr>
-      </table>
+        For previous releases, see the <a href="http://archive.apache.org/dist/commons/cli/">Apache
Archive</a>.
+      </p>
     </section>
--->
+
+    <section name="Support">
+      <p>The <a href="mail-lists.html">commons mailing lists</a> act as
the main support forum. The user list
+      is suitable for most library usage queries. The dev list is intended for the development
discussion. Please
+      remember that the lists are shared between all commons components, so prefix your email
subject by
+      <code>[cli]</code>.</p>
+
+      <p>Issues may be reported via the <a href="issue-tracking.html">ASF JIRA</a>.</p>
+    </section>
+
+
+      <!--      <p>
+              CLI1 was formed by the merger of ideas and code from three different
+              libraries and allows most simple interfaces to be modelled.  CLI1
+              became increasingly difficult to maintain and develop further and so
+              CLI2 has been developed with the goals of clearer responsibilities and
+              being more flexible.  The intention is that CLI2 should be able to
+              model a far greater selection of interfaces and do so more completely,
+              validating as much as possible.
+            </p>
+            <p>
+              The redesigned CLI2 is rooted in the <code>org.apache.commons.cli2</code>
+              package and the distribution retains the <code>org.apache.commons.cli</code>
+              package so that the upgrade doesn't break old code.  The CLI1 package
+              should be regarded as deprecated to encourage the transition to the
+              more flexible CLI2 framework but minor bug fixes and patches may be
+              accepted to ensure that CLI1 based applications continue to function as
+              expected.
+            </p>
+            <p>
+              The rest of the documentation is split into the following three sections:
+              <ul>
+                <li><a href="manual/index.html">CLI2</a> - a reference
manual for version 2</li>
+                <li><a href="introduction.html">CLI1</a> - documentation
for version 1 </li>
+                <li><a href="examples/index.html">Examples</a> - a selection
of worked examples demonstrating CLI2 features</li>
+              </ul>
+            </p>
+            <p>
+              The latest version of this documentation is available on the web:
+              <ul>
+                <li><a href="http://commons.apache.org/cli/">http://commons.apache.org/cli/</a></li>
+                <li>
+                  <a href="http://commons.apache.org/cli/commons-cli.pdf">http://commons.apache.org/cli/commons-cli.pdf</a>
+                  <a href="http://commons.apache.org/cli/commons-cli.pdf"><img border="0"
src="images/pdf.gif"/></a>
+                </li>
+              </ul>
+            </p>
+          </section>
+          <section name="Dependancies">
+            <p>
+              The generated list of <a href="dependencies.html">dependencies</a>
+              lists the libraries needed to compile and test Commons CLI.  To use
+              the precompiled distribution none of these dependancies are strictly
+              necessary.  The following is a breakdown of what is required and when:
+            </p>
+            <table>
+              <tr>
+                <th>Library</th><th>Usage</th>
+              </tr>
+              <tr>
+                <td>Java 1.2</td>
+                <td>This is the minimum java level needed to use CLI2</td>
+              </tr>
+              <tr>
+                <td>Java 1.4</td>
+                <td>Needed if the PreferencesCommandLine is needed</td>
+              </tr>
+              <tr>
+                <td>commons-lang</td>
+                <td>Needed if the CLI1 package is being used</td>
+              </tr>
+              <tr>
+                <td>jdepend</td>
+                <td>Needed to build and test CLI2 only</td>
+              </tr>
+              <tr>
+                <td>junit</td>
+                <td>Needed to build and test CLI1 and CLI2</td>
+              </tr>
+            </table>
+          </section>
+      -->
   </body>
 
 </document>

Modified: commons/proper/cli/trunk/xdocs/introduction.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/introduction.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/introduction.xml (original)
+++ commons/proper/cli/trunk/xdocs/introduction.xml Wed Jul 30 07:53:29 2008
@@ -39,9 +39,9 @@
         to define the interface to the application.
       </p>
       <p>
-        CLI uses the <a href="api-1.1/org/apache/commons/cli/Options.html">
+        CLI uses the <a href="api-1.2/org/apache/commons/cli/Options.html">
         Options</a> class, as a container for 
-        <a href="api-1.1/org/apache/commons/cli/Option.html">
+        <a href="api-1.2/org/apache/commons/cli/Option.html">
         Option</a> instances.  There are two ways to create
         <code>Option</code>s in CLI.  One of them is via the constructors,
         the other way is via the factory methods defined in 
@@ -66,11 +66,11 @@
       </p>
       <p>
         The <code>parse</code> method defined on 
-        <a href="api-1.1/org/apache/commons/cli/CommandLineParser.html">
+        <a href="api-1.2/org/apache/commons/cli/CommandLineParser.html">
         CommandLineParser</a> takes an <code>Options</code>
         instance and a <code>String[]</code> of arguments and 
         returns a 
-        <a href="api-1.1/org/apache/commons/cli/CommandLine.html">
+        <a href="api-1.2/org/apache/commons/cli/CommandLine.html">
         CommandLine</a>.
       </p>
       <p>

Modified: commons/proper/cli/trunk/xdocs/properties.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/properties.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/properties.xml (original)
+++ commons/proper/cli/trunk/xdocs/properties.xml Wed Jul 30 07:53:29 2008
@@ -28,10 +28,10 @@
     <section name="Option Properties">
       <p>
         The following are the properties that each 
-        <a href="api-1.1/org/apache/commons/cli/Option.html">Option</a> has.
 All of these
+        <a href="api-1.2/org/apache/commons/cli/Option.html">Option</a> has.
 All of these
         can be set using the accessors or using the methods
         defined in the
-        <a href="api-1.1/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
+        <a href="api-1.2/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
       </p>
       <table>
         <tr>

Modified: commons/proper/cli/trunk/xdocs/release_1_0.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/release_1_0.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/release_1_0.xml (original)
+++ commons/proper/cli/trunk/xdocs/release_1_0.xml Wed Jul 30 07:53:29 2008
@@ -17,14 +17,14 @@
 -->
 <document>
  <properties>
-  <title>Release notes for 1.0</title>
+  <title>Release notes for CLI 1.0</title>
   <author email="dev@commons.apache.org">Commons Documentation Team</author>
  </properties>
 <body>
 
 <section name="Release notes">
 <p>
-These are the release notes for Commons-CLI version 1.0.
+These are the release notes for Commons CLI 1.0.
 <source>
 INTRODUCTION:
 

Added: commons/proper/cli/trunk/xdocs/release_1_2.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/release_1_2.xml?rev=681071&view=auto
==============================================================================
--- commons/proper/cli/trunk/xdocs/release_1_2.xml (added)
+++ commons/proper/cli/trunk/xdocs/release_1_2.xml Wed Jul 30 07:53:29 2008
@@ -0,0 +1,101 @@
+<?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>Release notes for CLI 1.2</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+<body>
+
+<section name="Release notes">
+
+  <p>These are the release notes for Commons CLI 1.2.</p>
+
+<source>
+INTRODUCTION:
+
+This document contains the release notes for this version of the Commons CLI
+package. Commons CLI provides a simple API for working with the command line
+arguments and options.
+
+Commons CLI 1.2 is a bugfix release. The following notable changes were made:
+
+ * A major regression introduced in CLI 1.1 that prevented the usage of repeated options
has been fixed.
+ * Several parser issues have been fixed, especially with the PosixParser.
+ * HelpFormatter now wraps the lines properly
+ * The ordering of the option in the help message can now be defined.
+ * Various API enhancements (improved exceptions, serializable classes)
+
+Commons CLI 1.2 is binary compatible with the previous versions, except for
+the OptionValidator class that is no longer public.
+
+More information can be found on the project site at http://commons.apache.org/cli
+
+
+NEW FEATURES:
+
+  * The method getOptionProperties() in the CommandLine class was added
+    to retrieve easily the key/value pairs specified with options like
+    -Dkey1=value1 -Dkey2=value2.
+
+  * GnuParser now supports long options with an '=' sign
+    (ie. --foo=bar and -foo=bar) (CLI-157)
+
+  * The ordering of options can be defined in help messages. (CLI-155)
+
+
+BUG FIXES:
+
+  * The number of arguments defined for an option specifies the arguments
+    per occurrence of the option and not for all occurrences. (CLI-137)
+
+  * PosixParser no longer ignores unrecognized short options. (CLI-164)
+
+  * PosixParser no longer stops the bursting process of a token if stopAtNonOption
+    is enabled and a non option character is encountered. (CLI-163)
+
+  * PosixParser no longer keeps processing the tokens after an unrecognized
+    long option when stopAtNonOption is enabled. (CLI-165)
+
+  * Required options are properly checked if an Options instance is used twice
+    to parse a command line. (CLI-156)
+
+  * The line wrapping in HelpFormatter now works properly. (CLI-151)
+
+
+CHANGES:
+
+  * The message of MissingOptionException has been improved. (CLI-149)
+
+  * The exceptions have been enhanced with methods to retrieve easily
+    the related options. (CLI-86)
+
+  * Option.toString() now reports arguments properly. (CLI-141)
+
+  * The Parser class has been changed to be more easily extendable. (CLI-142)
+
+  * The following classes are now serializable: Option, OptionGroup,
+    CommandLine and Options. (CLI-140)
+
+  * OptionValidator is no longer public, its methods were all private.
+</source>
+
+</section>
+
+</body>
+</document>

Propchange: commons/proper/cli/trunk/xdocs/release_1_2.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: commons/proper/cli/trunk/xdocs/release_1_2.xml
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Modified: commons/proper/cli/trunk/xdocs/usage.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/xdocs/usage.xml?rev=681071&r1=681070&r2=681071&view=diff
==============================================================================
--- commons/proper/cli/trunk/xdocs/usage.xml (original)
+++ commons/proper/cli/trunk/xdocs/usage.xml Wed Jul 30 07:53:29 2008
@@ -45,7 +45,7 @@
       </subsection>
       <subsection name="Create the Options">
         <p>
-          An <a href="api-1.1/org/apache/commons/cli/Options.html">
+          An <a href="api-1.2/org/apache/commons/cli/Options.html">
           Options</a> object must be created and the <code>Option</code>
must be 
           added to it.
         </p>
@@ -78,7 +78,7 @@
         <p>
           Now we need to check if the <code>t</code> option is present.  To do
           this we will interrogate the 
-          <a href="api-1.1/org/apache/commons/cli/CommandLine.html">CommandLine
+          <a href="api-1.2/org/apache/commons/cli/CommandLine.html">CommandLine
           </a> object.  The <code>hasOption</code> method takes a 
           <code>java.lang.String</code> parameter and returns <code>true</code>
if the option 
           represented by the <code>java.lang.String</code> is present, otherwise

@@ -212,11 +212,11 @@
       <subsection name="Create the Options">
         <p>
           Now that we have created each 
-          <a href="api-1.1/org/apache/commons/cli/Option.html">Option</a> we
need 
+          <a href="api-1.2/org/apache/commons/cli/Option.html">Option</a> we
need
           to create the 
-          <a href="api-1.1/org/apache/commons/cli/Options.html">Options</a> 
+          <a href="api-1.2/org/apache/commons/cli/Options.html">Options</a>
           instance.  This is achieved using the 
-          <a href="api-1.1/org/apache/commons/cli/CommandLine.html#addOption(org.apache.commons.cli.Option)">addOption</a>

+          <a href="api-1.2/org/apache/commons/cli/CommandLine.html#addOption(org.apache.commons.cli.Option)">addOption</a>
           method of <code>Options</code>.
         </p>
         <source>Options options = new Options();
@@ -243,8 +243,8 @@
         <p>
           We now need to create a <code>Parser</code>.  This will parse the command
           line arguments, using the rules specified by the <code>Options</code>
and
-          return an instance of <a href="api-1.1/org/apache/commons/cli/CommandLine.html">CommandLine</a>.
-          This time we will use a <a href="api-1.1/org/apache/commons/cli/GnuParser.html">GnuParser</a>
+          return an instance of <a href="api-1.2/org/apache/commons/cli/CommandLine.html">CommandLine</a>.
+          This time we will use a <a href="api-1.2/org/apache/commons/cli/GnuParser.html">GnuParser</a>
           which is able to handle options that are more than one character long.
         </p>
         <source>public static void main( String[] args ) {
@@ -276,7 +276,7 @@
         <p>
           CLI also provides the means to automatically generate usage
           and help information.  This is achieved with the
-          <a href="api-1.1/org/apache/commons/cli/HelpFormatter.html">HelpFormatter</a>
+          <a href="api-1.2/org/apache/commons/cli/HelpFormatter.html">HelpFormatter</a>
           class.
         </p>
         <source>// automatically generate the help statement
@@ -311,7 +311,7 @@
       <p>
         One of the most widely used command line applications in the *nix world
         is <code>ls</code>.  To parse a command line for an application like
this
-        we will use the <a href="api-1.1/org/apache/commons/cli/PosixParser.html">PosixParser</a>.
+        we will use the <a href="api-1.2/org/apache/commons/cli/PosixParser.html">PosixParser</a>.
         Due to the large number of options required for <code>ls</code> this
         example will only cover a small proportion of the options.  The following
         is a section of the help output.
@@ -332,7 +332,7 @@
 -C                         list entries by columns</source>
       <p>
         The following is the code that is used to create the 
-        <a href="api-1.1/org/apache/commons/cli/Options.html">Options</a> for
this example.
+        <a href="api-1.2/org/apache/commons/cli/Options.html">Options</a> for
this example.
       </p>
       <source>// create the command line parser
 CommandLineParser parser = new PosixParser();



Mime
View raw message