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
This commit is contained in:
Stephen Colebourne
parent
01bf1138f9
commit
a60c74f75f
|
|
@ -0,0 +1,58 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2005 The Apache Software Foundation.
|
||||
|
||||
Licensed 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 iouage governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<document>
|
||||
<properties>
|
||||
<title>Building</title>
|
||||
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
|
||||
</properties>
|
||||
<body>
|
||||
<!-- ================================================== -->
|
||||
<section name="Building Commons Collections">
|
||||
<p>
|
||||
Commons Collections uses <a href="http://ant.apache.org">Ant</a> as its
|
||||
primary build system, however <a href="http://maven.apache.org">Maven</a>
|
||||
is used for site generation.
|
||||
</p>
|
||||
<!--p>
|
||||
You may also be interested in the <a href="upgradeto1_1.html">upgrade notes</a>.
|
||||
</p-->
|
||||
</section>
|
||||
<!-- ================================================== -->
|
||||
<section name="Ant Goals">
|
||||
<p>
|
||||
To build a jar file, change into Collection's root directory and run "ant jar".
|
||||
The result will be in the "build" subdirectory.
|
||||
</p>
|
||||
<p>
|
||||
To build the Javadocs, run "ant javadoc".
|
||||
The result will be in "build/docs/apidocs".
|
||||
</p>
|
||||
</section>
|
||||
<!-- ================================================== -->
|
||||
<section name="Maven Goals">
|
||||
<p>
|
||||
To build the Javadocs, change into Collection's root directory and run "maven javadoc".
|
||||
The result will be in "target/docs/apidocs".
|
||||
</p>
|
||||
<p>
|
||||
To build the full website, run "maven site".
|
||||
The result will be in "target/docs".
|
||||
</p>
|
||||
</section>
|
||||
<!-- ================================================== -->
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2005 The Apache Software Foundation.
|
||||
|
||||
Licensed 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 iouage governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<document>
|
||||
<properties>
|
||||
<title>Source repository</title>
|
||||
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
|
||||
</properties>
|
||||
<body>
|
||||
<!-- ================================================== -->
|
||||
<section name="Source repository">
|
||||
<p>
|
||||
Jakarta Commons Collections is hosted on the Apache
|
||||
<a href="http://subversion.tigris.org/">subversion</a> repository.
|
||||
</p>
|
||||
<p>
|
||||
The project URL is:<br />
|
||||
<code>http://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk</code>
|
||||
</p>
|
||||
<p>
|
||||
The best way to view the repository is via the
|
||||
<a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/collections/trunk/">subversion viewer</a>.
|
||||
</p>
|
||||
<p>
|
||||
The alternative is to use the
|
||||
<a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk/">native subversion</a> display.
|
||||
</p>
|
||||
</section>
|
||||
<!-- ================================================== -->
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2005 The Apache Software Foundation.
|
||||
|
||||
Licensed 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 iouage governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<document>
|
||||
<properties>
|
||||
<title>Issue tracking</title>
|
||||
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
|
||||
</properties>
|
||||
<body>
|
||||
<!-- ================================================== -->
|
||||
<section name="Issue tracking">
|
||||
<p>
|
||||
Commons Collections uses <a href="http://issues.apache.org/bugzilla/">ASF Bugzilla</a> for tracking issues.
|
||||
To use Bugzilla you may need to <a href="http://issues.apache.org/bugzilla/createaccount.cgi">create an account</a>.
|
||||
</p>
|
||||
<p>
|
||||
If you would like to report a bug, or raise an enhancement request with
|
||||
Commons Collections please do the following:
|
||||
<ol>
|
||||
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&product=Commons&component=Collections">Search existing open bugs</a>.
|
||||
If you find your issue listed then please add a comment with your details.</li>
|
||||
<li><a href="http://mail-archives.apache.org/mod_mbox/jakarta-commons-dev/">Search the mailing list archive</a>.
|
||||
You may find your issue or idea has already been discussed.</li>
|
||||
<li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&component=Collections&version=3.1">Submit a bug report or enhancement request</a>.
|
||||
Please prefix all new issues with [collections] in the summary line.
|
||||
</li>
|
||||
</ol>
|
||||
</p>
|
||||
<p>
|
||||
Please also remember these points:
|
||||
<ul>
|
||||
<li>the more information you provide, the better we can help you</li>
|
||||
<li>test cases are vital, particularly for any proposed enhancements</li>
|
||||
<li>the developers of Commons Collections are all unpaid volunteers</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
You may also find these links useful:
|
||||
<ul>
|
||||
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&product=Commons&component=Collections">All Open Collections bugs</a></li>
|
||||
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&product=Commons&component=Collections">All Closed Collections bugs</a></li>
|
||||
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&product=Commons&component=Collections">All Collections bugs</a></li>
|
||||
</ul>
|
||||
</p>
|
||||
</section>
|
||||
<!-- ================================================== -->
|
||||
</body>
|
||||
</document>
|
||||
Loading…
Reference in New Issue