Apache/commons-math
1
0
Fork 0
mirror of https://github.com/apache/commons-math.git synced 2025-02-07 18:49:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Miscellaneous updates / fixes

Browse Source 
* Drop mention of Maven 2 (was distinguishing from Maven 1, which no longer really exists)
* Remind people to make diffs from top level project directory
* Don't tell people to make Wiki pages (not open access any more)
* Drop (now false) statement that all exceptions inherit from MRE



git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1541347 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Phil Steitz 2013-11-13 01:24:17 +00:00
parent 5df86e5cb2
commit 04078798c0
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/site/xdoc/developers.xml
View File

@ -58,13 +58,11 @@
<source>https://svn.apache.org/repos/asf/commons/proper/math/trunk</source> <source>https://svn.apache.org/repos/asf/commons/proper/math/trunk</source>
</li> </li>
<li>Like most commons components, Commons Math uses Apache Maven as our <li>Like most commons components, Commons Math uses Apache Maven as our
build tool. We now use Maven 2 as our primary build platform (what build tool. The sources can also be built using Ant (a working
we use to cut releases, for continuous integration builds, and for
development). The sources can also be built using Ant (a working
Ant build.xml is included in the top level project directory). Ant build.xml is included in the top level project directory).
To build Commons Math using Maven 2, you can follow the instructions for To build Commons Math using Maven, you can follow the instructions for
<a href="http://maven.apache.org/run-maven/index.html">Building a <a href="http://maven.apache.org/run-maven/index.html">Building a
project with Maven 2</a>. Launch Maven from the top-level directory project with Maven</a>. Launch Maven from the top-level directory
in the checkout of Commons Math trunk. No special setup is required, in the checkout of Commons Math trunk. No special setup is required,
except that currently to build the site (i.e. to execute Maven's except that currently to build the site (i.e. to execute Maven's
"site" goal), you may need to increase the default memory allocation "site" goal), you may need to increase the default memory allocation
@ -98,6 +96,8 @@
the Unified Diff format, which can be easily generated using the svn the Unified Diff format, which can be easily generated using the svn
client or various IDEs. client or various IDEs.
<source>svn diff > patch </source> <source>svn diff > patch </source>
Run this command from the top-level project directory (where pom.xml
resides).
</li> </li>
</li> </li>
</ol> </ol>
@ -126,11 +126,7 @@
the next step is to add an entry to the the next step is to add an entry to the
<a href="http://wiki.apache.org/commons/MathWishList">Math Wish <a href="http://wiki.apache.org/commons/MathWishList">Math Wish
List</a> corresponding to the idea. Include a reference to the List</a> corresponding to the idea. Include a reference to the
discussion thread and, for substantial enhancements, a new Wiki page discussion thread. </li>
named using the enhancement / addition name, e.g.
"PrincipalComponentsAnalysis." We can then us this page to lay out the
development plan and track progress and decisions related to the
feature.</li>
<li>Create a JIRA ticket using the the feature title as the short <li>Create a JIRA ticket using the the feature title as the short
description. Incorporate feedback from the initial posting in the description. Incorporate feedback from the initial posting in the
description. Add a reference to the JIRA ticket to the WishList entry. description. Add a reference to the JIRA ticket to the WishList entry.
@ -204,8 +200,6 @@
and the documentation in the javadoc <i>must</i> include full description and the documentation in the javadoc <i>must</i> include full description
of the conditions under which exceptions are thrown.</li> of the conditions under which exceptions are thrown.</li>
<li> <li>
All exceptions inherit from the base class, MathRuntimeException.</li>
<li>
Methods <i>should</i> fully specify parameter preconditions required for Methods <i>should</i> fully specify parameter preconditions required for
successful activation. When preconditions are violated, a successful activation. When preconditions are violated, a
MathIllegalArgumentException should be thrown. Subclasses of MathIllegalArgumentException should be thrown. Subclasses of