From a60c74f75ff887f13e12a5bd6edac24cc47f60fb Mon Sep 17 00:00:00 2001 From: Stephen Colebourne Date: Sun, 13 Nov 2005 15:44:47 +0000 Subject: [PATCH] Update docs prior to 3.2 git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@333027 13f79535-47bb-0310-9956-ffa450edef68 --- xdocs/building.xml | 58 ++++++++++++++++++++++++++++++++++++++ xdocs/cvs-usage.xml | 44 +++++++++++++++++++++++++++++ xdocs/issue-tracking.xml | 61 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 163 insertions(+) create mode 100644 xdocs/building.xml create mode 100644 xdocs/cvs-usage.xml create mode 100644 xdocs/issue-tracking.xml diff --git a/xdocs/building.xml b/xdocs/building.xml new file mode 100644 index 000000000..956c33ad9 --- /dev/null +++ b/xdocs/building.xml @@ -0,0 +1,58 @@ + + + + + Building + Commons Documentation Team + + + +
+

+ Commons Collections uses Ant as its + primary build system, however Maven + is used for site generation. +

+ +
+ +
+

+ To build a jar file, change into Collection's root directory and run "ant jar". + The result will be in the "build" subdirectory. +

+

+ To build the Javadocs, run "ant javadoc". + The result will be in "build/docs/apidocs". +

+
+ +
+

+ To build the Javadocs, change into Collection's root directory and run "maven javadoc". + The result will be in "target/docs/apidocs". +

+

+ To build the full website, run "maven site". + The result will be in "target/docs". +

+
+ + + diff --git a/xdocs/cvs-usage.xml b/xdocs/cvs-usage.xml new file mode 100644 index 000000000..9a75b99ae --- /dev/null +++ b/xdocs/cvs-usage.xml @@ -0,0 +1,44 @@ + + + + + Source repository + Commons Documentation Team + + + +
+

+ Jakarta Commons Collections is hosted on the Apache + subversion repository. +

+

+ The project URL is:
+ http://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk +

+

+ The best way to view the repository is via the + subversion viewer. +

+

+ The alternative is to use the + native subversion display. +

+
+ + + diff --git a/xdocs/issue-tracking.xml b/xdocs/issue-tracking.xml new file mode 100644 index 000000000..e37c1fcd6 --- /dev/null +++ b/xdocs/issue-tracking.xml @@ -0,0 +1,61 @@ + + + + + Issue tracking + Commons Documentation Team + + + +
+

+ Commons Collections uses ASF Bugzilla for tracking issues. + To use Bugzilla you may need to create an account. +

+

+ If you would like to report a bug, or raise an enhancement request with + Commons Collections please do the following: +

    +
  1. Search existing open bugs. + If you find your issue listed then please add a comment with your details.
    2. +
  2. Search the mailing list archive. + You may find your issue or idea has already been discussed.
    3. +
  3. Submit a bug report or enhancement request. + Please prefix all new issues with [collections] in the summary line. +
    4. +
+

+

+ Please also remember these points: +

    +
  • the more information you provide, the better we can help you
    • +
  • test cases are vital, particularly for any proposed enhancements
    • +
  • the developers of Commons Collections are all unpaid volunteers
    • +
+

+

+ You may also find these links useful: +

+

+
+ + +