Merge branch 'master' into 1.0-release
Applied "Commons Rng" -> "Commons RNG" replacement.
Removed unnecessary section of the userguide (license specification).
Expanded "Overview" section of the userguide.
Updated release instructions to include "README.md" and "CONTRIBUTING.md" in the distribution files.
diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt
index 12a0a69..3cabadf 100644
--- a/doc/release/release.howto.txt
+++ b/doc/release/release.howto.txt
@@ -15,7 +15,7 @@
# limitations under the License.
This document is meant as a step-by-step recipe to achieve the release of
-the Commons Rng component. Note that more general instructions valid
+the Commons RNG component. Note that more general instructions valid
for all components, including [rng], are available on the Apache Commons
main site: at "http://commons.apache.org/releases/prepare.html" and
"http://commons.apache.org/releases/release.html".
@@ -201,7 +201,7 @@
be the same as in the "<properties>" in the "pom.xml"), and the command
will be:
- $ git tag -s -m "RC1." RNG_1_0_RC1
+ $ git tag -u "__Your_key_id__" -s -m "RC1." RNG_1_0_RC1
If you have several GPG keys, you may prefer to use "-u keyId" to select a specific
key for signing the tag instead of "-s" which select automatically one key
@@ -220,7 +220,7 @@
RC1.
-followed by GPG output lines
+followed by GPG output lines.
Remember the commit ID listed in the object line (here cf4a9d70c9ac24dd7196995390171150e4e56451),
as it is the most stable reference for traceability.
@@ -244,6 +244,7 @@
Check that the last commit has the id you noted in the previous step:
+ $ cd commons-rng
$ git log -1
@@ -290,15 +291,15 @@
and their signatures
<file-name>.asc
-Note that Nexus automatically adds "md5" and "sha1" checksums files to the "asc"
-files (cryptographic signature). These fingerprints on signatures are spurious
-and have to be manually removed from Nexus staging area.
+Nexus used to add "md5" and "sha1" checksums files to the "asc" files
+(cryptographic signature). If these fingerprints on signatures are
+present, they must be manually removed from Nexus staging area.
The process also transfers the complete source and binaries distributions files:
- commons-rng-1.0.-bin.tar.gz
- commons-rng-1.0.-bin.zip
- commons-rng-1.0.-src.tar.gz
- commons-rng-1.0.-src.zip
+ commons-rng-1.0-bin.tar.gz
+ commons-rng-1.0-bin.zip
+ commons-rng-1.0-src.tar.gz
+ commons-rng-1.0-src.zip
as well as their associated .md5 and .sha1 fingerprints and .asc signatures.
All these files are not maven artifacts but rather distribution archives: They
belong elsewhere; hence they must also been removed from the Nexus staging
@@ -331,8 +332,14 @@
$ cp ~/.m2/repository/org/apache/commons/commons-rng/1.0/*-bin.* binaries
$ cp ~/.m2/repository/org/apache/commons/commons-rng/1.0/*-src.* source
$ cp <path-to-the-RC-workspace>/RELEASE-NOTES.txt .
- $ svn add README.html RELEASE-NOTES.txt binaries/* source/*
- $ svn commit -m "Distribution files for Commons Rng v1.0 (RC1)."
+ $ svn add \
+ CONTRIBUTING.md \
+ README.md \
+ README.html \
+ RELEASE-NOTES.txt \
+ binaries/* \
+ source/*
+ $ svn commit -m "Distribution files for Commons RNG v1.0 (RC1)."
(13)
@@ -353,7 +360,7 @@
$ mvn site
$ cd target
$ mv site commons-rng-1.0-RC1-site
- $ lftp sftp://__Your_apache_login__@home.apache.org/
+ $ lftp sftp://__Your_apache_login__@home.apache.org
lftp you@home.apache.org:~> cd public_html
lftp you@home.apache.org:~/public_html> mirror -R commons-rng-1.0-RC1-site
lftp you@home.apache.org:~/public_html> bye
@@ -361,22 +368,22 @@
(14)
Call to vote by sending a message to the "dev" ML with subject
-"[VOTE][RC1] Release Commons Rng 1.0". You can use the following example as
+"[VOTE][RC1] Release Commons RNG 1.0". You can use the following example as
a starting point, replacing the URLs with the appropriate ones:
----------
-This is a [VOTE] for releasing Apache Commons Rng 1.0 (from RC1).
+This is a [VOTE] for releasing Apache Commons RNG 1.0 (from RC1).
Tag name:
RNG_1_0_RC1 (signature can be checked from git using 'git tag -v')
Tag URL:
- <https://git-wip-us.apache.org/repos/asf?p=commons-rng.git;a=commit;h=cf4a9d70c9ac24dd7196995390171150e4e56451>
+ https://git-wip-us.apache.org/repos/asf?p=commons-rng.git;a=commit;h=cf4a9d70c9ac24dd7196995390171150e4e56451
Commit ID the tag points at:
cf4a9d70c9ac24dd7196995390171150e4e56451
Site:
- <http://home.apache.org/~__Your_apache_login__/commons-rng-1.0-RC1-site>
+ http://home.apache.org/~__Your_apache_login__/commons-rng-1.0-RC1-site
Distribution files:
https://dist.apache.org/repos/dist/dev/commons/rng/
@@ -391,7 +398,7 @@
http://www.apache.org/dist/commons/KEYS
Maven artifacts:
- https://repository.apache.org/content/repositories/orgapachecommons-051/org/apache/commons/commons-rng3/1.0/
+ https://repository.apache.org/content/repositories/orgapachecommons-051/org/apache/commons/commons-rng/1.0/
[ ] +1 Release it.
[ ] +0 Go ahead; I don't care.
@@ -442,7 +449,7 @@
mv dev/commons/rng/source/commons-rng-1.0-src.zip.asc release/commons/rng/source/commons-rng-1.0-src.zip.asc \
mv dev/commons/rng/source/commons-rng-1.0-src.zip.md5 release/commons/rng/source/commons-rng-1.0-src.zip.md5 \
mv dev/commons/rng/source/commons-rng-1.0-src.zip.sha1 release/commons/rng/source/commons-rng-1.0-src.zip.sha1 \
- -m "Release Commons Rng v1.0"
+ -m "Release Commons RNG v1.0"
(18)
@@ -556,9 +563,9 @@
----------
The Apache Commons Team is pleased to announce the availability of:
-Apache Commons Rng 1.0
+Apache Commons RNG 1.0
-Apache Commons Rng provides Java implementations of pseudo-random
+Apache Commons RNG provides Java implementations of pseudo-random
numbers generators.
The release notes can be reviewed at:
diff --git a/pom.xml b/pom.xml
index 433b229..0a157fd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -28,10 +28,10 @@
<artifactId>commons-rng</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
- <name>Apache Commons Rng</name>
+ <name>Apache Commons RNG</name>
<inceptionYear>2016</inceptionYear>
- <description>The Apache Commons Rng project provides implementations of random numbers generators.</description>
+ <description>The Apache Commons RNG project provides implementations of random numbers generators.</description>
<url>http://commons.apache.org/proper/commons-rng/</url>
@@ -66,6 +66,9 @@
<contributor>
<name>Artem Barger</name>
</contributor>
+ <contributor>
+ <name>Rob Tompkins</name>
+ </contributor>
</contributors>
<dependencies>
@@ -217,61 +220,62 @@
</configuration>
</plugin>
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <executions>
- <execution>
- <phase>package</phase>
- <configuration>
- <target>
- <jar destfile="${project.build.directory}/${project.artifactId}-${project.version}-tools.jar">
- <metainf dir="${basedir}" includes="NOTICE.txt,LICENSE.txt" />
- <manifest>
- <attribute name="Specification-Title" value="${project.name} Tools" />
- <attribute name="Implementation-Title" value="${project.name} Tools" />
- <attribute name="Implementation-Vendor" value="${project.organization.name}" />
- <attribute name="Implementation-Version" value="${project.version}" />
- <attribute name="Implementation-Vendor-Id" value="org.apache" />
- <attribute name="Implementation-Build" value="${implementation.build}"/>
- <attribute name="X-Compile-Source-JDK" value="${maven.compiler.source}" />
- <attribute name="X-Compile-Target-JDK" value="${maven.compiler.target}" />
- </manifest>
- <fileset dir="${project.build.directory}/test-classes"
- includes="org/apache/commons/rng/PerfTestUtils*" />
- </jar>
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
+ <!-- <plugin> -->
+ <!-- <artifactId>maven-antrun-plugin</artifactId> -->
+ <!-- <executions> -->
+ <!-- <execution> -->
+ <!-- <phase>package</phase> -->
+ <!-- <configuration> -->
+ <!-- <target> -->
+ <!-- <jar destfile="${project.build.directory}/${project.artifactId}-${project.version}-tools.jar"> -->
+ <!-- <metainf dir="${basedir}" includes="NOTICE.txt,LICENSE.txt" /> -->
+ <!-- <manifest> -->
+ <!-- <attribute name="Specification-Title" value="${project.name} Tools" /> -->
+ <!-- <attribute name="Implementation-Title" value="${project.name} Tools" /> -->
+ <!-- <attribute name="Implementation-Vendor" value="${project.organization.name}" /> -->
+ <!-- <attribute name="Implementation-Version" value="${project.version}" /> -->
+ <!-- <attribute name="Implementation-Vendor-Id" value="org.apache" /> -->
+ <!-- <attribute name="Implementation-Build" value="${implementation.build}"/> -->
+ <!-- <attribute name="X-Compile-Source-JDK" value="${maven.compiler.source}" /> -->
+ <!-- <attribute name="X-Compile-Target-JDK" value="${maven.compiler.target}" /> -->
+ <!-- </manifest> -->
+ <!-- <fileset dir="${project.build.directory}/test-classes" -->
+ <!-- includes="org/apache/commons/rng/PerfTestUtils*" /> -->
+ <!-- </jar> -->
+ <!-- </target> -->
+ <!-- </configuration> -->
+ <!-- <goals> -->
+ <!-- <goal>run</goal> -->
+ <!-- </goals> -->
+ <!-- </execution> -->
+ <!-- </executions> -->
+ <!-- </plugin> -->
<!-- Attaches the commons-rng tools JAR to the Maven lifecycle
to ensure they will be signed and deployed as normal -->
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>build-helper-maven-plugin</artifactId>
- <version>1.7</version>
- <executions>
- <execution>
- <id>attach-artifacts</id>
- <phase>package</phase>
- <goals>
- <goal>attach-artifact</goal>
- </goals>
- <configuration>
- <artifacts>
- <artifact>
- <file>${project.build.directory}/${project.artifactId}-${project.version}-tools.jar</file>
- <type>jar</type>
- <classifier>tools</classifier>
- </artifact>
- </artifacts>
- </configuration>
- </execution>
- </executions>
- </plugin>
+ <!-- <plugin> -->
+ <!-- <groupId>org.codehaus.mojo</groupId> -->
+ <!-- <artifactId>build-helper-maven-plugin</artifactId> -->
+ <!-- <version>1.7</version> -->
+ <!-- <executions> -->
+ <!-- <execution> -->
+ <!-- <id>attach-artifacts</id> -->
+ <!-- <phase>package</phase> -->
+ <!-- <goals> -->
+ <!-- <goal>attach-artifact</goal> -->
+ <!-- </goals> -->
+ <!-- <configuration> -->
+ <!-- <artifacts> -->
+ <!-- <artifact> -->
+ <!-- <file>${project.build.directory}/${project.artifactId}-${project.version}-tools.jar</file> -->
+ <!-- <type>jar</type> -->
+ <!-- <classifier>tools</classifier> -->
+ <!-- </artifact> -->
+ <!-- </artifacts> -->
+ <!-- </configuration> -->
+ <!-- </execution> -->
+ <!-- </executions> -->
+ <!-- </plugin> -->
+
<!-- MathJax -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index e14ae86..21eaf39 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -47,14 +47,14 @@
<document>
<properties>
- <title>Commons Rng Release Notes</title>
+ <title>Apache Commons RNG Release Notes</title>
</properties>
<body>
- <release version="1.0" date="2016-09-17" description="
-This is the first release of Commons Rng.
+ <release version="1.0" date="2016-09-20" description="
+This is the first release of Apache Commons RNG.
The minimum version of the Java platform required to compile and use
- Commons Rng 1.0 is Java 6.
+ Apache Commons RNG 1.0 is Java 6.
">
<!-- <action dev="erans" type="fix" issue="RNG-xxx"> -->
<!-- </action> -->
diff --git a/src/site/apt/userguide/rng.apt b/src/site/apt/userguide/rng.apt
index d9eb847..63985a8 100644
--- a/src/site/apt/userguide/rng.apt
+++ b/src/site/apt/userguide/rng.apt
@@ -16,12 +16,12 @@
~~
-----------------------------
- The Commons Rng User Guide
+ The Apache Commons RNG User Guide
-----------------------------
1. Usage overview
- <<<Commons Rng>>> provides generators of random sequences of numbers.
+ <<<Commons RNG>>> provides generators of random sequences of numbers.
Please refer to the {{{../apidocs/index.html}Javadoc}} for details on
the API illustrated by the following examples.
@@ -501,16 +501,4 @@
5. Dependencies
- Commons Rng requires JDK 1.6+ and has no runtime dependencies.
-
-6. License
-
- Commons Rng is distributed under the terms of the
- {{{http://www.apache.org/licenses/LICENSE-2.0}Apache License, Version 2.0}}.
-
- This product includes software developed by other third parties and
- distributed under licenses terms compatible with Apache License, Version 2.0.
- All the licenses of such third parties products are available in the distribution
- in the LICENSE.txt file. Some products require additional attribution, these
- attributions can be found in the NOTICE.txt file. These files are available
- both in the source packages and in the binaries distribution jar files.
+ Apache Commons RNG requires JDK 1.6+ and has no runtime dependencies.
diff --git a/src/site/site.xml b/src/site/site.xml
index b5f4ad3..b38068f 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -15,15 +15,15 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project name="Rng">
+<project name="RNG">
<bannerRight>
- <name>Commons Rng</name>
+ <name>Apache Commons RNG</name>
<src>/images/commons_rng.small.png</src>
<href>/index.html</href>
</bannerRight>
<body>
- <menu name="Rng">
+ <menu name="RNG">
<item name="Overview" href="/index.html"/>
<item name="Downloads" href="http://commons.apache.org/rng/download_rng.cgi"/>
<item name="Latest API docs (development)" href="apidocs/index.html"/>
@@ -33,7 +33,7 @@
<item name="Source Repository (current)"
href="http://git-wip-us.apache.org/repos/asf/commons-rng.git"/>
<!-- <item name="Wiki" -->
- <!-- href="http://wiki.apache.org/commons/Rng"/> -->
+ <!-- href="http://wiki.apache.org/commons/RNG"/> -->
<item name="Developers Guide" href="/developers.html"/>
</menu>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index ffdfd92..dabc77e 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -20,46 +20,44 @@
<document>
<properties>
- <title>Commons Rng</title>
+ <title>Commons RNG</title>
</properties>
<body>
- <section name="Commons Rng: Random numbers generators" href="summary">
+ <section name="Apache Commons RNG: Random Numbers Generators" href="summary">
<p>
- Commons Rng provides implementations of pseudo-random numbers generators.
+ Commons RNG provides implementations of pseudo-random numbers generators that are
+ either faster or of higher quality (and sometimes both) than <code>java.lang.Random</code>.
+ </p>
+
+ <p>
+ Casual use is as simple as:
+
+<source>import org.apache.commons.rng.UniformRandomProvider;
+import org.apache.commons.rng.RandomSource;
+
+// Instantiate a "Mersenne-Twister" generator with a factory method.
+UniformRandomProvider rng = RandomSource.create(RandomSource.MT);
+
+// Use it to produce a floating-point value between 0 and 1.
+double random = rng.nextDouble();
+</source>
+
+ </p>
+
+ <p>
+ For more examples and more advanced usage, see the <a href="userguide/rng.html">userguide</a>.
</p>
</section>
- <section name="Download Rng">
+ <section name="Download Apache Commons RNG">
<subsection name="Releases">
<p>
- <i>There isn't any release yet.</i>
+ Download the
+ <a href="http://commons.apache.org/rng/download_rng.cgi">
+ Latest Release</a> of Apache Commons RNG.
</p>
-
- <p>
- Work is currently performed actively towards release 1.0:
- <a href="https://issues.apache.org/jira/browse/RNG-6">See our issue-tracking system.</a>
- </p>
-
- <p>
- <b>Interested people are most welcome to review the API for this important milestone:</b>
- Source code is available from <a href="./source-repository.html">a git repository at Apache</a>
- or from its <a href="https://github.com/apache/commons-rng">Github</a> mirror.
- </p>
-
- <p>
- <b>"Beta-testers" are welcome to test the library</b> by downloading the
- <a href="https://repository.apache.org/content/repositories/snapshots/org/apache/commons/commons-rng/1.0-SNAPSHOT/">
- <i><b>unofficial 1.0-SNAPSHOT JAR</b></i>
- </a> that is generated through <a href="https://builds.apache.org/view/Apache%20Commons/job/Commons_Rng/">continuous integration</a>.
- </p>
-
- <!-- <p> -->
- <!-- Download the -->
- <!-- <a href="http://commons.apache.org/rng/download_rng.cgi"> -->
- <!-- Latest Release</a> of Commons Rng. -->
- <!-- </p> -->
</subsection>
</section>
diff --git a/src/site/xdoc/userguide/index.xml b/src/site/xdoc/userguide/index.xml
index 4599a88..9e6df58 100644
--- a/src/site/xdoc/userguide/index.xml
+++ b/src/site/xdoc/userguide/index.xml
@@ -48,10 +48,6 @@
<a href="rng.html#a5._Dependencies">
5. Dependencies</a>
</li>
- <li>
- <a href="rng.html#a6._License">
- 6. License</a>
- </li>
</ul>
</section>
