You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2019/11/13 00:12:49 UTC
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git.
from 67d5ceb Fix update instructions for the website.
new 70b40d6 Update site menu for the modules.
new ec52674 Update <source> example for the sampling index page.
new 79240ec xdoc <source> tag is not allowed inside paragraphs.
new 041adb6 Doxia: Remove nested block level elements.
new 29cda7b Update developers guidelines.
new ab5d86b Moved <head> tag of site descriptor.
new 46fc244 Add PractRand to development howto guide.
The 7 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
commons-rng-client-api/src/site/site.xml | 6 +-
commons-rng-client-api/src/site/xdoc/index.xml | 2 +-
commons-rng-core/src/site/site.xml | 6 +-
commons-rng-sampling/src/site/site.xml | 6 +-
commons-rng-sampling/src/site/xdoc/index.xml | 4 +-
commons-rng-simple/src/site/site.xml | 6 +-
commons-rng-simple/src/site/xdoc/index.xml | 2 +-
doc/development/development.howto.txt | 4 +-
doc/release/release.howto.txt | 3 +-
src/site/site.xml | 15 +-
src/site/xdoc/developers.xml | 212 ++++++++++++-------------
src/site/xdoc/index.xml | 3 +-
12 files changed, 132 insertions(+), 137 deletions(-)
[commons-rng] 03/07: xdoc tag is not allowed inside
paragraphs.
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 79240eccd54721216ca7267a26e5eb9f833b1f6d
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Tue Nov 12 22:06:46 2019 +0000
xdoc <source> tag is not allowed inside paragraphs.
---
commons-rng-client-api/src/site/xdoc/index.xml | 2 +-
commons-rng-simple/src/site/xdoc/index.xml | 2 +-
src/site/xdoc/index.xml | 3 +--
3 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/commons-rng-client-api/src/site/xdoc/index.xml b/commons-rng-client-api/src/site/xdoc/index.xml
index 7a30c6d..d7bcc10 100644
--- a/commons-rng-client-api/src/site/xdoc/index.xml
+++ b/commons-rng-client-api/src/site/xdoc/index.xml
@@ -37,6 +37,7 @@
<p>
Example:
+ </p>
<source>import org.apache.commons.rng.UniformRandomProvider;
@@ -46,7 +47,6 @@ public class Dice {
}
}
</source>
- </p>
<p>
Browse the <a href="apidocs/index.html">Javadoc</a> to see the complete API.
diff --git a/commons-rng-simple/src/site/xdoc/index.xml b/commons-rng-simple/src/site/xdoc/index.xml
index 88f0128..c579f3d 100644
--- a/commons-rng-simple/src/site/xdoc/index.xml
+++ b/commons-rng-simple/src/site/xdoc/index.xml
@@ -38,6 +38,7 @@
<p>
Example:
+ </p>
<source>import org.apache.commons.rng.UniformRandomProvider;
import org.apache.commons.rng.simple.RandomSource;
@@ -50,7 +51,6 @@ public class Dice {
}
}
</source>
- </p>
<p>
Browse the <a href="apidocs/index.html">Javadoc</a> for more information.
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index fb56555..c894fa1 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -33,6 +33,7 @@
<p>
Casual use is as simple as:
+ </p>
<source>import org.apache.commons.rng.UniformRandomProvider;
import org.apache.commons.rng.simple.RandomSource;
@@ -44,8 +45,6 @@ UniformRandomProvider rng = RandomSource.create(RandomSource.MT);
double random = rng.nextDouble();
</source>
- </p>
-
<p>
For more examples and more advanced usage, see the <a href="userguide/rng.html">userguide</a>.
</p>
[commons-rng] 06/07: Moved tag of site descriptor.
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit ab5d86bca2b26836ee10c0b6cac1b1256b762866
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Wed Nov 13 00:03:41 2019 +0000
Moved <head> tag of site descriptor.
The tag must be before <body>. However it still does not enable MathJax.
Tests using the <footer> tag are also ignored in the final site so the
tags must be being replaced by other content.
---
src/site/site.xml | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/src/site/site.xml b/src/site/site.xml
index d065401..86a757f 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -15,7 +15,10 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project name="RNG">
+<project name="RNG"
+ xmlns="http://maven.apache.org/DECORATION/1.6.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.6.0 http://maven.apache.org/xsd/decoration-1.6.0.xsd">
<bannerRight>
<name>Apache Commons RNG</name>
<src>/images/commons_rng.small.png</src>
@@ -23,6 +26,11 @@
</bannerRight>
<body>
+ <head>
+ <![CDATA[<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+ </script>]]>
+ </head>
+
<menu name="RNG">
<item name="Overview" href="/index.html"/>
<item name="Downloads" href="https://commons.apache.org/rng/download_rng.cgi"/>
@@ -39,10 +47,5 @@
<item name="Contents" href="/userguide/index.html"/>
</menu>
- <head>
- <![CDATA[<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
- </script>]]>
- </head>
-
</body>
</project>
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 29cda7b7336d9089aac1779cbb349f3739fb08df
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Wed Nov 13 00:00:14 2019 +0000
Update developers guidelines.
There is no need to configure core.autocrlf as the repo uses
.gitattributes.
Use https for links if available.
Updated some expired links:
Numerical recipes
Apache CLA
Oracle Code guidelines
Removed reference to RNG wishlist. It is not available on Confluence.
---
src/site/xdoc/developers.xml | 44 +++++++++++++++-----------------------------
1 file changed, 15 insertions(+), 29 deletions(-)
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index 0378d9f..f3e3aa3 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -57,7 +57,7 @@
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 RNG using Maven, you can follow the instructions for
- <a href="http://maven.apache.org/run-maven/index.html">Building a
+ <a href="https://maven.apache.org/run-maven/index.html">Building a
project with Maven</a>.
Launch Maven from the top-level directory
in the checkout of Commons RNG trunk. No special setup is required,
@@ -67,11 +67,6 @@
Maven.
</li>
<li>
- Have a look at the new features that users and developers have requested
- on the <a href="http://wiki.apache.org/commons/RngWishList">
- RNG Wish List Wiki Page.</a>
- </li>
- <li>
Be sure to join the commons-dev and commons-user
<a href="mail-lists.html">
email lists</a> and use them appropriately (make sure the string
@@ -127,13 +122,9 @@
useful</li>
</ul></li>
<li>Assuming a generally favorable response to the idea on commons-dev,
- the next step is to add an entry to the
- <a href="http://wiki.apache.org/commons/RngWishList">RNG Wish
- List</a> corresponding to the idea. Include a reference to the
- discussion thread. </li>
- <li>Create a JIRA ticket using the the feature title as the short
+ 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.
+ description.
</li>
<li>Submit code as attachments to the JIRA ticket. Please use one
ticket for each feature, adding multiple patches to the ticket
@@ -148,27 +139,22 @@
<subsection name='Coding Style'>
<p>
- Commons RNG follows <a href="http://java.sun.com/docs/codeconv/">Code
+ Commons RNG follows
+ <a href="https://www.oracle.com/technetwork/java/codeconventions-150003.pdf">Code
Conventions for the Java Programming Language</a>. As part of the maven
build process, style checking is performed using the Checkstyle plugin,
using the properties specified in <code>checkstyle.xml</code>.
Committed code <i>should</i> generate no Checkstyle errors. One thing
- that Checkstyle will complain about is tabs included in the source code.
+ that Checkstyle will complain about is tabs included in the code code.
Please make sure to set your IDE or editor to use spaces instead of tabs.
</p>
<p>
- Committers should configure the <source>user.name</source>,
- <source>user.email</source> and <source>core.autocrlf</source>
- git repository or global settings with <source>git config</source>.
- The first two settings define the identity and mail of the committer.
- The third setting deals with line endings to achieve consistency
- in line endings. Windows users should configure this setting to
- <source>true</source> (thus forcing git to convert CR/LF line endings
- in the workspace while maintaining LF only line endings in the repository)
- while OS X and Linux users should configure it to <source>input</source>
- (thus forcing git to only strip accidental CR/LF when committing into
- the repository, but never when cheking out files from the repository). See <a
- href="http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration">Customizing
+ Committers should configure the git repository or global settings for:
+ </p>
+ <source>user.name
+user.email</source>
+ <p>These settings define the identity and mail of the committer. See <a
+ href="https://www.git-scm.com/book/en/Customizing-Git-Git-Configuration">Customizing
Git - Git Configuration</a> in the git book for explanation about how to
configure these settings and more.
</p>
@@ -189,7 +175,7 @@
</li>
<li>
Commons RNG javadoc generation supports embedded LaTeX formulas via the
- <a href="http://www.mathjax.org">MathJax</a> javascript display engine.
+ <a href="https://www.mathjax.org">MathJax</a> javascript display engine.
To embed mathematical expressions formatted in LaTeX in javadoc, simply surround
the expression to be formatted with either <code>\(</code> and <code>\)</code>
for inline formulas (or <code>\[</code> and <code>\]</code> to have the formula
@@ -250,7 +236,7 @@
</li>
<li>
All contributions must comply with the terms of the Apache
- <a href="http://www.apache.org/licenses/cla.pdf">Contributor License
+ <a href="https://www.apache.org/licenses/contributor-agreements.html">Contributor License
Agreement (CLA)</a>.
</li>
<li>
@@ -264,7 +250,7 @@
References to source materials covered by restrictive proprietary
licenses should be avoided. In particular, contributions should not
implement or include references to algorithms in
- <a href="http://www.nr.com/">Numerical Recipes (NR)</a>.
+ <a href="http://numerical.recipes/">Numerical Recipes (NR)</a>.
Any questions about copyright or patent issues should be raised on
the commons-dev mailing list before contributing or committing code.
</li>
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 041adb6dee5e95344872ea641be2ada3252f6665
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Tue Nov 12 22:12:45 2019 +0000
Doxia: Remove nested block level elements.
This removes <ol> elements from inside <p> elements.
---
src/site/xdoc/developers.xml | 192 +++++++++++++++++++++----------------------
1 file changed, 95 insertions(+), 97 deletions(-)
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index 15c2f77..0378d9f 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -40,112 +40,110 @@
</p>
<subsection name="Contributing">
<p><strong>Getting Started</strong></p>
- <p>
- <ol>
- <li>
- Download the Commons RNG source code. Follow the instructions
- under the heading "Repository Checkout" on the
- <a href="https://gitbox.apache.org/">Git at the ASF page</a>.
- The git url for the current development sources of Commons RNG
- is <source>http://gitbox.apache.org/repos/asf/commons-rng.git</source>
- for anonymous read-only access and
- <source>https://apacheid@gitbox.apache.org/repos/asf/commons-rng.git</source>
- (where apacheid should be replaced by each committer Apache ID) for committers
- read-write access.
- </li>
- <li>
- Like most commons components, Commons RNG uses Apache Maven as our
- 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 RNG using Maven, you can follow the instructions for
- <a href="http://maven.apache.org/run-maven/index.html">Building a
- project with Maven</a>.
- Launch Maven from the top-level directory
- in the checkout of Commons RNG 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
- (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
- Maven.
- </li>
- <li>
- Have a look at the new features that users and developers have requested
- on the <a href="http://wiki.apache.org/commons/RngWishList">
- RNG Wish List Wiki Page.</a>
- </li>
- <li>
- Be sure to join the commons-dev and commons-user
- <a href="mail-lists.html">
- email lists</a> and use them appropriately (make sure the string
- "[RNG]" starts the Subject line of all your postings).
- Make any proposals here where the group can comment on them.
- </li>
+ <ol>
+ <li>
+ Download the Commons RNG source code. Follow the instructions
+ under the heading "Repository Checkout" on the
+ <a href="https://gitbox.apache.org/">Git at the ASF page</a>.
+ The git url for the current development sources of Commons RNG
+ is <source>http://gitbox.apache.org/repos/asf/commons-rng.git</source>
+ for anonymous read-only access and
+ <source>https://apacheid@gitbox.apache.org/repos/asf/commons-rng.git</source>
+ (where apacheid should be replaced by each committer Apache ID) for committers
+ read-write access.
+ </li>
+ <li>
+ Like most commons components, Commons RNG uses Apache Maven as our
+ 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 RNG using Maven, you can follow the instructions for
+ <a href="http://maven.apache.org/run-maven/index.html">Building a
+ project with Maven</a>.
+ Launch Maven from the top-level directory
+ in the checkout of Commons RNG 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
+ (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
+ Maven.
+ </li>
+ <li>
+ Have a look at the new features that users and developers have requested
+ on the <a href="http://wiki.apache.org/commons/RngWishList">
+ RNG Wish List Wiki Page.</a>
+ </li>
+ <li>
+ Be sure to join the commons-dev and commons-user
+ <a href="mail-lists.html">
+ email lists</a> and use them appropriately (make sure the string
+ "[RNG]" starts the Subject line of all your postings).
+ Make any proposals here where the group can comment on them.
+ </li>
+ <li>
+ <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
+ Setup an account on JIRA
+ </a>
+ and use it to submit patches and
+ identify bugs. Read the
+ <a href="https://issues.apache.org/bugwritinghelp.html">
+ directions</a>
+ for submitting bugs and search the database to
+ determine if an issue exists or has already been dealt with.
+ <p>
+ See the <a href="https://commons.apache.org/rng/issue-tracking.html">
+ Commons RNG Issue Tracking Page</a>
+ for more information on how to
+ search for or submit bugs or enhancement requests.
+ </p>
<li>
- <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
- Setup an account on JIRA
- </a>
- and use it to submit patches and
- identify bugs. Read the
- <a href="https://issues.apache.org/bugwritinghelp.html">
- directions</a>
- for submitting bugs and search the database to
- determine if an issue exists or has already been dealt with.
- <p>
- See the <a href="https://commons.apache.org/rng/issue-tracking.html">
- Commons RNG Issue Tracking Page</a>
- for more information on how to
- search for or submit bugs or enhancement requests.
- </p>
- <li>
- Generating patches: The requested format for generating patches is
- the Unified Diff format, which can be easily generated using the git
- client or various IDEs.
- <source>git diff -p > patch </source>
- Run this command from the top-level project directory (where pom.xml
- resides).
- </li>
+ Generating patches: The requested format for generating patches is
+ the Unified Diff format, which can be easily generated using the git
+ client or various IDEs.
+ <source>git diff -p > patch </source>
+ Run this command from the top-level project directory (where pom.xml
+ resides).
</li>
- </ol>
- </p>
+ </li>
+ </ol>
<p><strong>Contributing ideas and code</strong></p>
<p>
Follow the steps below when making suggestions for additions or
enhancements to Commons RNG. This will make it easier for the community
to comment on your ideas and for the committers to keep track of them.
Thanks in advance!
- <ol>
- <li>Start with a post to the commons-dev mailing list, with [RNG] at
- the beginning of the subject line, followed by a short title
- describing the new feature or enhancement; for example, "[RNG]
- New cryptographically secure generator".
- The body of the post should include each of the following items
- (but be <strong>as brief as possible</strong>):
- <ul>
- <li>A concise description of the new feature / enhancement</li>
- <li>References to definitions and algorithms. Using standard
- definitions and algorithms makes communication much easier and will
- greatly increase the chances that we will accept the code / idea</li>
- <li>Some indication of why the addition / enhancement is practically
- useful</li>
- </ul></li>
- <li>Assuming a generally favorable response to the idea on commons-dev,
- the next step is to add an entry to the
- <a href="http://wiki.apache.org/commons/RngWishList">RNG Wish
- List</a> corresponding to the idea. Include a reference to the
- discussion thread. </li>
- <li>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.
- </li>
- <li>Submit code as attachments to the JIRA ticket. Please use one
- ticket for each feature, adding multiple patches to the ticket
- as necessary. Use the git diff command to generate your patches as
- diffs. Please do not submit modified copies of existing java files. Be
- patient (but not <strong>too</strong> patient) with committers reviewing
- patches. Post a *nudge* message to commons-dev with a reference to the
- ticket if a patch goes more than a few days with no comment or commit.
- </li>
- </ol>
</p>
+ <ol>
+ <li>Start with a post to the commons-dev mailing list, with [RNG] at
+ the beginning of the subject line, followed by a short title
+ describing the new feature or enhancement; for example, "[RNG]
+ New cryptographically secure generator".
+ The body of the post should include each of the following items
+ (but be <strong>as brief as possible</strong>):
+ <ul>
+ <li>A concise description of the new feature / enhancement</li>
+ <li>References to definitions and algorithms. Using standard
+ definitions and algorithms makes communication much easier and will
+ greatly increase the chances that we will accept the code / idea</li>
+ <li>Some indication of why the addition / enhancement is practically
+ useful</li>
+ </ul></li>
+ <li>Assuming a generally favorable response to the idea on commons-dev,
+ the next step is to add an entry to the
+ <a href="http://wiki.apache.org/commons/RngWishList">RNG Wish
+ List</a> corresponding to the idea. Include a reference to the
+ discussion thread. </li>
+ <li>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.
+ </li>
+ <li>Submit code as attachments to the JIRA ticket. Please use one
+ ticket for each feature, adding multiple patches to the ticket
+ as necessary. Use the git diff command to generate your patches as
+ diffs. Please do not submit modified copies of existing java files. Be
+ patient (but not <strong>too</strong> patient) with committers reviewing
+ patches. Post a *nudge* message to commons-dev with a reference to the
+ ticket if a patch goes more than a few days with no comment or commit.
+ </li>
+ </ol>
</subsection>
<subsection name='Coding Style'>
[commons-rng] 02/07: Update example for the sampling index
page.
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit ec52674d49351bdb271b6c0021148e65a726ced3
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Tue Nov 12 22:02:22 2019 +0000
Update <source> example for the sampling index page.
Correct the formatting and switch to using the 'of' factory constructor.
---
commons-rng-sampling/src/site/xdoc/index.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/commons-rng-sampling/src/site/xdoc/index.xml b/commons-rng-sampling/src/site/xdoc/index.xml
index 52f27ac..ccec820 100644
--- a/commons-rng-sampling/src/site/xdoc/index.xml
+++ b/commons-rng-sampling/src/site/xdoc/index.xml
@@ -44,10 +44,10 @@ import org.apache.commons.rng.sampling.distribution.ContinuousSampler;
import org.apache.commons.rng.sampling.distribution.MarsagliaNormalizedGaussianSampler;
public class NormalDeviates {
- private final ContinuousSampler normalizedGaussian;
+ private final ContinuousSampler normalizedGaussian;
public NormalDeviates(UniformRandomProvider rng) {
- normalizedGaussian = new MarsagliaNormalizedGaussianSampler(rng);
+ normalizedGaussian = MarsagliaNormalizedGaussianSampler.of(rng);
}
public double sample(double mean,
[commons-rng] 07/07: Add PractRand to development howto guide.
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 46fc244d480cf3f7d9629eeea5c7b3da022e3b83
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Wed Nov 13 00:12:44 2019 +0000
Add PractRand to development howto guide.
---
doc/development/development.howto.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/development/development.howto.txt b/doc/development/development.howto.txt
index e1a27bb..c70a2ab 100644
--- a/doc/development/development.howto.txt
+++ b/doc/development/development.howto.txt
@@ -38,7 +38,7 @@ if it comes with
1. a unit test where the output (say, a few hundred numbers) of "Commons RNG"
is compared against another implementation,
2. the outputs of the "RandomStressTester" (Java source is in module
- "commons-rng-examples"), piping from the "Dieharder" and "TU01/BigCrush"
- actual stress test suites (these software must be installed separately;
+ "commons-rng-examples"), piping from the "Dieharder", "TU01/BigCrush" and
+ "PractRand" stress test suites (these software must be installed separately;
the C source of a simple interface to the "TU01" library is in module
"commons-rng-examples").
[commons-rng] 01/07: Update site menu for the modules.
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 70b40d64bfe4a2e2afdec58d7add8a915ebfd151
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Tue Nov 12 21:43:17 2019 +0000
Update site menu for the modules.
- Add release 1.3 javadoc link
- Fix relative path for the top right banner image and link
Clarify release notes on where to update the site.xml.
---
commons-rng-client-api/src/site/site.xml | 6 ++++--
commons-rng-core/src/site/site.xml | 6 ++++--
commons-rng-sampling/src/site/site.xml | 6 ++++--
commons-rng-simple/src/site/site.xml | 6 ++++--
doc/release/release.howto.txt | 3 ++-
5 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/commons-rng-client-api/src/site/site.xml b/commons-rng-client-api/src/site/site.xml
index dea235e..ea0e6cf 100644
--- a/commons-rng-client-api/src/site/site.xml
+++ b/commons-rng-client-api/src/site/site.xml
@@ -18,8 +18,8 @@
<project name="RNG">
<bannerRight>
<name>Apache Commons RNG</name>
- <src>/images/commons_rng.small.png</src>
- <href>/index.html</href>
+ <src>../images/commons_rng.small.png</src>
+ <href>../index.html</href>
</bannerRight>
<body>
@@ -27,6 +27,8 @@
<item name="Overview" href="index.html"/>
<item name="Latest API docs (development)"
href="apidocs/index.html"/>
+ <item name="Javadoc (1.3 release)"
+ href="https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.3/index.html"/>
<item name="Javadoc (1.2 release)"
href="https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.2/index.html"/>
<item name="Javadoc (1.1 release)"
diff --git a/commons-rng-core/src/site/site.xml b/commons-rng-core/src/site/site.xml
index c3ae3d7..86e0837 100644
--- a/commons-rng-core/src/site/site.xml
+++ b/commons-rng-core/src/site/site.xml
@@ -18,8 +18,8 @@
<project name="RNG">
<bannerRight>
<name>Apache Commons RNG</name>
- <src>/images/commons_rng.small.png</src>
- <href>/index.html</href>
+ <src>../images/commons_rng.small.png</src>
+ <href>../index.html</href>
</bannerRight>
<body>
@@ -27,6 +27,8 @@
<item name="Overview" href="index.html"/>
<item name="Latest API docs (development)"
href="apidocs/index.html"/>
+ <item name="Javadoc (1.3 release)"
+ href="https://commons.apache.org/rng/commons-rng-core/javadocs/api-1.3/index.html"/>
<item name="Javadoc (1.2 release)"
href="https://commons.apache.org/rng/commons-rng-core/javadocs/api-1.2/index.html"/>
<item name="Javadoc (1.1 release)"
diff --git a/commons-rng-sampling/src/site/site.xml b/commons-rng-sampling/src/site/site.xml
index a33ce05..8c98633 100644
--- a/commons-rng-sampling/src/site/site.xml
+++ b/commons-rng-sampling/src/site/site.xml
@@ -18,8 +18,8 @@
<project name="RNG">
<bannerRight>
<name>Apache Commons RNG</name>
- <src>/images/commons_rng.small.png</src>
- <href>/index.html</href>
+ <src>../images/commons_rng.small.png</src>
+ <href>../index.html</href>
</bannerRight>
<body>
@@ -27,6 +27,8 @@
<item name="Overview" href="index.html"/>
<item name="Latest API docs (development)"
href="apidocs/index.html"/>
+ <item name="Javadoc (1.3 release)"
+ href="https://commons.apache.org/rng/commons-rng-sampling/javadocs/api-1.3/index.html"/>
<item name="Javadoc (1.2 release)"
href="https://commons.apache.org/rng/commons-rng-sampling/javadocs/api-1.2/index.html"/>
<item name="Javadoc (1.1 release)"
diff --git a/commons-rng-simple/src/site/site.xml b/commons-rng-simple/src/site/site.xml
index 00bd879..0a5230e 100644
--- a/commons-rng-simple/src/site/site.xml
+++ b/commons-rng-simple/src/site/site.xml
@@ -18,8 +18,8 @@
<project name="RNG">
<bannerRight>
<name>Apache Commons RNG</name>
- <src>/images/commons_rng.small.png</src>
- <href>/index.html</href>
+ <src>../images/commons_rng.small.png</src>
+ <href>../index.html</href>
</bannerRight>
<body>
@@ -27,6 +27,8 @@
<item name="Overview" href="index.html"/>
<item name="Latest API docs (development)"
href="apidocs/index.html"/>
+ <item name="Javadoc (1.3 release)"
+ href="https://commons.apache.org/rng/commons-rng-simple/javadocs/api-1.3/index.html"/>
<item name="Javadoc (1.2 release)"
href="https://commons.apache.org/rng/commons-rng-simple/javadocs/api-1.2/index.html"/>
<item name="Javadoc (1.1 release)"
diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt
index 9a7578e..76c5906 100644
--- a/doc/release/release.howto.txt
+++ b/doc/release/release.howto.txt
@@ -181,7 +181,8 @@ Update the release specific files, checking you are really working on the
In particular:
* Update and commit the "src/site/site.xml" file to contain the information
- about the API docs of the new release.
+ about the API docs of the new release. This is for each of
+ common-rng-<module> with <module>: client-api; core; sampling; and simple.
* Estimate a release date (taking into account the release vote delay) and
insert it in the "src/changes/changes.xml" file.
* Update the "pom.xml" to contain the final version number and not a SNAPSHOT: