From 04078798c0d744a41310ea7dd5d0baffee8df94a Mon Sep 17 00:00:00 2001 From: Phil Steitz Date: Wed, 13 Nov 2013 01:24:17 +0000 Subject: [PATCH] Miscellaneous updates / fixes * 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 --- src/site/xdoc/developers.xml | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml index 80fb11328..1c9d11760 100644 --- a/src/site/xdoc/developers.xml +++ b/src/site/xdoc/developers.xml @@ -58,13 +58,11 @@ https://svn.apache.org/repos/asf/commons/proper/math/trunk
  • Like most commons components, Commons Math uses Apache Maven as our - build tool. We now use Maven 2 as our primary build platform (what - we use to cut releases, for continuous integration builds, and for - development). The sources can also be built using Ant (a working + build tool. The sources can also be built using Ant (a working 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 Building a - project with Maven 2. Launch Maven from the top-level directory + project with Maven. Launch Maven from the top-level directory 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 "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 client or various IDEs. svn diff > patch + Run this command from the top-level project directory (where pom.xml + resides).
  • @@ -126,11 +126,7 @@ the next step is to add an entry to the Math Wish List corresponding to the idea. Include a reference to the - discussion thread and, for substantial enhancements, a new Wiki page - 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. + discussion thread.
  • Create a JIRA ticket using the the feature title as the short description. Incorporate feedback from the initial posting in the description. Add a reference to the JIRA ticket to the WishList entry. @@ -204,8 +200,6 @@ and the documentation in the javadoc must include full description of the conditions under which exceptions are thrown.
  • - All exceptions inherit from the base class, MathRuntimeException.
  • -
  • Methods should fully specify parameter preconditions required for successful activation. When preconditions are violated, a MathIllegalArgumentException should be thrown. Subclasses of