You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Alex Herbert <al...@gmail.com> on 2019/02/16 12:12:37 UTC
[Rng] README.md and broken javadoc link
The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
Given the use of sub-modules it appears the output README.md files have to be tweaked.
The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>. However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>?
Alex
Re: [Rng] README.md and broken javadoc link
Posted by Alex Herbert <al...@gmail.com>.
Hi Gilles,
> On 17 Feb 2019, at 23:25, Gilles Sadowski <gi...@gmail.com> wrote:
>
> Hello.
>
>> Le dim. 17 févr. 2019 à 23:57, Alex Herbert <al...@gmail.com> a écrit :
>>
>> Hi Gilles,
>>
>> This is related to the fix I made for MathJax. It apparently is not as simple as I thought, i.e. this was a hidden tag only for JDK 8. This tag is not officially documented so there is no official solution, only what you can find on the web.
>>
>> I had installed openJDK 9 on my linux machine to test building the JMS modules. I had to remove the --allow-script-in-comments tag to get it to build the javadocs. So I changed the latest pom.xml for commons-rng-parent to only add the tag on JDK 1.8. I found that if I had that tag on open JDK 9 the following fails:
>>
>> mvn -v
>> Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
>> Maven home: /usr/local/apache-maven-3.5.4
>> Java version: 9-internal, vendor: Oracle Corporation, runtime: /usr/lib/jvm/java-9-openjdk-amd64
>> Default locale: en_GB, platform encoding: UTF-8
>> OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: "unix"
>>
>> java -version
>> openjdk version "9-internal"
>> OpenJDK Runtime Environment (build 9-internal+0-2016-04-14-195246.buildd.src)
>> OpenJDK 64-Bit Server VM (build 9-internal+0-2016-04-14-195246.buildd.src, mixed mode)
>>
>> mvn javadoc:javadoc
>>
>> Is OK.
>>
>> mvn javadoc:javadoc -Pjdk8-javadoc
>>
>> Does NOT work.
>>
>> I have just tried:
>>
>> mvn clean site site:stage -Pcommons-rng-examples
>>
>> This is fails on the client-api module with this weird error running the findbugs report:
>>
>> [INFO] Fork Value is true
>> [java] Exception in thread "main" java.io.IOException: IOException while scanning codebases
>> [java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:282)
>> [java] at edu.umd.cs.findbugs.FindBugs.runMain(FindBugs.java:401)
>> [java] at edu.umd.cs.findbugs.FindBugs2.main(FindBugs2.java:1187)
>> [java] Caused by: edu.umd.cs.findbugs.classfile.ResourceNotFoundException: Resource not found: java/lang/Object.class
>> [java] at edu.umd.cs.findbugs.classfile.impl.ClassPathImpl.lookupResource(ClassPathImpl.java:164)
>> [java] at edu.umd.cs.findbugs.classfile.impl.ClassPathBuilder.build(ClassPathBuilder.java:282)
>> [java] at edu.umd.cs.findbugs.FindBugs2.buildClassPath(FindBugs2.java:674)
>> [java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:215)
>> [java] ... 2 more
>>
>> So the I am thinking the jdk9 install I am using is broken and probably too old to have the hidden --allow-script-in-comments option for javadoc.
>>
>> You could try running with the 'jdk8-javadoc’ profile on your java 9 and see if that fixes the problem for you.
>>
>> Can you let me know what version of java 9 you are using?
>
> Command
> $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
> -Pcommons-rng-examples -Pjdk8-javadoc clean package site site:stage
> works on
> $ /usr/lib/jvm/java-9-openjdk-amd64/bin/java -version
> openjdk version "9-Debian"
> OpenJDK Runtime Environment (build 9-Debian+0-9b181-4bpo91)
> OpenJDK 64-Bit Server VM (build 9-Debian+0-9b181-4bpo91, mixed mode)
>
> I missed when the "jdk8-javadoc" profile became mandatory. Is there a
> way to have it activated automatically when necessary (e.g. when compiling
> with a JKD >= 8)?
Yes, it was originally put in the profile with the checkstyle configuration for any JDK from 8 onwards. I made the new profile because it worked on my machine that way with java 9. It would appear that my version of Java 9 is old and is missing the requirement for the --allow-script-in-comments tag.
I’ll update my JDK 9, verify I can do the full build and revert the parent Pom.xml.
Alex
>
> Gilles
>
>>
>> Alex
>>
>>
>>> On 17 Feb 2019, at 22:03, Gilles Sadowski <gi...@gmail.com> wrote:
>>>
>>> Hi Alex.
>>>
>>> I tried to regenerate the site but the build fails:
>>> ---CUT---
>>> [INFO] Reactor Summary:
>>> [INFO]
>>> [INFO] Apache Commons RNG ................................. SUCCESS [ 21.050 s]
>>> [INFO] Apache Commons RNG Client API ...................... FAILURE [ 7.723 s]
>>> [INFO] Apache Commons RNG Core ............................ SKIPPED
>>> [INFO] Apache Commons RNG Simple .......................... SKIPPED
>>> [INFO] Apache Commons RNG Sampling ........................ SKIPPED
>>> [INFO] Apache Commons RNG Examples ........................ SKIPPED
>>> [INFO] Stress test example ................................ SKIPPED
>>> [INFO] Sampling example ................................... SKIPPED
>>> [INFO] Quadrature example ................................. SKIPPED
>>> [INFO] JMH Benchmark ...................................... SKIPPED
>>> [INFO] JPMS Integration test .............................. SKIPPED
>>> [INFO] JPMS module example (library) ...................... SKIPPED
>>> [INFO] JPMS module example (application) .................. SKIPPED
>>> [INFO] ------------------------------------------------------------------------
>>> [INFO] BUILD FAILURE
>>> [INFO] ------------------------------------------------------------------------
>>> [INFO] Total time: 29.294 s
>>> [INFO] Finished at: 2019-02-17T22:52:17+01:00
>>> [INFO] Final Memory: 82M/220M
>>> [INFO] ------------------------------------------------------------------------
>>> [ERROR] Failed to execute goal
>>> org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site)
>>> on project commons-rng-client-api: Error generating
>>> maven-javadoc-plugin:3.0.1:javadoc report:
>>> [ERROR] Exit code: 1 - javadoc: error - option -header contains JavaScript.
>>> [ERROR] Use --allow-script-in-comments to allow use of JavaScript.
>>> [ERROR]
>>> [ERROR] Command line was:
>>> /usr/lib/jvm/java-9-openjdk-amd64/bin/javadoc @options @package
>>> ---CUT---
>>>
>>> Command line was:
>>> $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
>>> -Pcommons-rng-examples clean site site:stage
>>>
>>> Regards,
>>> Gilles
>>>
>>> P.S. I'd wait for the new RNG implementations to be in "master" before
>>> updating the
>>> live site (so that "current" will refer to "1.3-SNAPSHOT").
>>>
>>>
>>>> Le dim. 17 févr. 2019 à 16:08, Alex Herbert <alex.d.herbert@gmail.com <ma...@gmail.com>> a écrit :
>>>>
>>>>
>>>>
>>>>> On 16 Feb 2019, at 21:31, Gilles Sadowski <gi...@gmail.com> wrote:
>>>>>
>>>>> Hello.
>>>>>
>>>>>> Le sam. 16 févr. 2019 à 13:12, Alex Herbert <al...@gmail.com> a écrit :
>>>>>>
>>>>>> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
>>>>>>
>>>>>> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
>>>>>>
>>>>>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
>>>>>>
>>>>>> Given the use of sub-modules it appears the output README.md files have to be tweaked.
>>>>>>
>>>>>> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>.
>>>>>
>>>>> I don't see those links: the apidocs are hosted on the Apache server:
>>>>> https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html> <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>>
>>>>
>>>> The javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> badges are put at the top of the README.md by the latest commons build plugin. It seems that when you visit javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> at the link this prompts them to get the public release and then create the javadoc pages on this site. All the badges I have tested do eventually build and show javadoc.
>>>>
>>>> The latest README.md updates the badges so that:
>>>>
>>>> - build status badge drops the '?branch=master’ parameter
>>>> - coverage badge drops the '?branch=master’ parameter
>>>> - maven central badge is unchanged *
>>>> - The licence badge is dropped
>>>> - The java docs badge is added to refer to javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>
>>>>
>>>> * This badge used the artefact name so has to be updated for the main README.md page as that refers to commons-rng-parent. All the sub-modules are OK. I just pointed it to commons-ring-simple.
>>>>
>>>> So should the javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> badge be dropped and the licence badge reinstated manually?
>>>>
>>>>>
>>>>>> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/> <https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>>?
>>>>>
>>>>> It doesn't bother me that there is no aggregate Javadoc; the modules can be
>>>>> seen as separate libraries with different target audiences.
>>>>> The broken link in README.md should be replaced by links to the each of the
>>>>> modules.
>>>>>
>>>>> Regards,
>>>>> Gilles
>>>>
>>>> OK. I have tweaked the output from the commons build plugin for the main page to add javadoc links for client-api, core, simple and sampling.
>>>>
>>>> I updated all the other README.md files to:
>>>>
>>>> - manually fix the javadoc link in the modules with javadoc *
>>>> - not refer to the module name but ‘Apache Commons RNG’ for the donate link.
>>>> - use <commons.componentid>rng</commons.componentid> as the example property
>>>> - drop the RNG from the auto-generated [Apache Commons RNG homepage](https://commons.apache.org/ <https://commons.apache.org/>)
>>>>
>>>> * The javadoc here:
>>>> https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/> <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>>
>>>> Is for 1.1-SNAPSHOT. Some modules are missing (e.g. commons-ring-examples-quadrature).
>>>>
>>>> So the 1.2 release did not deploy apidocs for commons-examples? I do not know how to browse the hosting server to check. If missing then the apidocs should be fixed (uploaded). If it is not official to host these I can update the README.md to remove the browse link.
>>>>
>>>> You can see the latest comparison with what was previously in the README at this link:
>>>>
>>>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>>
>>>>
>>>> You can view the pages here:
>>>>
>>>> https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme> <https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>>
>>>>
>>>> I think all the links work in all the modules except the missing javadocs for the commons-examples modules.
>>>>
>>>> The badges, [Contributing], [License] and [Additional Resource] sections are all now up-to-date with the latest from the commons build plugin. The latest description from the pom.xml is also included.
>>>>
>>>>
>>>>
>>>>
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org <ma...@commons.apache.org>
>>> For additional commands, e-mail: dev-help@commons.apache.org <ma...@commons.apache.org>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [Rng] README.md and broken javadoc link
Posted by Alex Herbert <al...@gmail.com>.
Hi Gilles,
I was just drafting an e-mail stating I had found my mistake.
> On 18 Feb 2019, at 22:18, Gilles Sadowski <gi...@gmail.com> wrote:
>
> Hi.
>
> Le lun. 18 févr. 2019 à 16:22, Alex Herbert <al...@gmail.com> a écrit :
>>
>>>> [...]
>>>
>>> Command
>>> $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
>>> -Pcommons-rng-examples -Pjdk8-javadoc clean package site site:stage
>>> works on
>>> $ /usr/lib/jvm/java-9-openjdk-amd64/bin/java -version
>>> openjdk version "9-Debian"
>>> OpenJDK Runtime Environment (build 9-Debian+0-9b181-4bpo91)
>>> OpenJDK 64-Bit Server VM (build 9-Debian+0-9b181-4bpo91, mixed mode)
>>>
>>> I missed when the "jdk8-javadoc" profile became mandatory. Is there a
>>> way to have it activated automatically when necessary (e.g. when compiling
>>> with a JKD >= 8)?
>>>
>>> Gilles
>>
>> I’ve removed the linux distribution version of OpenJDK 9 and manually installed OpenJDK 9, 10 and 11.
>>
>> I confirm these versions all require the --allow-script-in-comments option for 'mvn javadoc:javadoc'. So I’ve reverted the pom.xml to put this back in the profile for JDK 1.8+.
>>
>> I get a module error when building on OpenJDK 9:
>>
>> mvn -v
>> Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
>> Maven home: /usr/local/apache-maven-3.5.4
>> Java version: 9, vendor: Oracle Corporation, runtime: /usr/lib/jvm/jdk-9
>> Default locale: en_GB, platform encoding: UTF-8
>> OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: “unix"
>>
>> mvn clean site site:stage -Pcommons-rng-exampless
>>
>> [INFO] Reactor Summary:
>> [INFO]
>> [INFO] Apache Commons RNG 1.3-SNAPSHOT .................... SUCCESS [ 13.143 s]
>> [INFO] Apache Commons RNG Client API ...................... SUCCESS [ 8.144 s]
>> [INFO] Apache Commons RNG Core ............................ SUCCESS [ 19.623 s]
>> [INFO] Apache Commons RNG Simple .......................... SUCCESS [ 13.773 s]
>> [INFO] Apache Commons RNG Sampling ........................ SUCCESS [01:07 min]
>> [INFO] Apache Commons RNG Examples ........................ SUCCESS [ 3.871 s]
>> [INFO] Stress test example ................................ SUCCESS [ 6.715 s]
>> [INFO] Sampling example ................................... SUCCESS [ 6.155 s]
>> [INFO] Quadrature example ................................. SUCCESS [ 5.808 s]
>> [INFO] JMH Benchmark ...................................... SUCCESS [ 22.310 s]
>> [INFO] JPMS Integration test .............................. SUCCESS [ 1.895 s]
>> [INFO] JPMS module example (library) ...................... FAILURE [ 0.559 s]
>> [INFO] JPMS module example (application) 1.3-SNAPSHOT ..... SKIPPED
>> [INFO] ------------------------------------------------------------------------
>> [INFO] BUILD FAILURE
>> [INFO] ------------------------------------------------------------------------
>> [INFO] Total time: 02:49 min
>> [INFO] Finished at: 2019-02-18T13:54:01Z
>> [INFO] ------------------------------------------------------------------------
>> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site) on project commons-rng-examples-jpms-lib: failed to get report for org.apache.maven.plugins:maven-surefire-report-plugin: Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.7.0:compile (default-compile) on project commons-rng-examples-jpms-lib: Compilation failure: Compilation failure:
>> [ERROR] /home/ah403/git/commons-rng/commons-rng-examples/examples-jpms/jpms-lib/src/main/java/module-info.java:[18,36] module not found: org.apache.commons.rng.api
>> [ERROR] /home/ah403/git/commons-rng/commons-rng-examples/examples-jpms/jpms-lib/src/main/java/module-info.java:[19,36] module not found: org.apache.commons.rng.sampling
>>
>>
>> I tried mvn 3.5.4 and 3.6.0.
>>
>> This can be reduced to just running:
>>
>> mvn compile in commons-rng-examples/examples-jpms
>
> Works here (maven downloads the "1.3-SNAPSHOT" artefacts from the
> Apache repository).
>
>>
>> Something about this machine setup does not like the modules setup. I had a dig around and thought updating this module definition would work:
>>
>> module org.apache.commons.rng.examples.jpms.lib {
>> requires org.apache.commons.rng;
>> requires org.apache.commons.rng.sampling.distribution;
>> exports org.apache.commons.rng.examples.jpms.lib;
>> }
>>
>> The module currently requires ‘o.a.c.rng.api’ which doesn’t exist and ‘o.a.c.rng.sampling’ which needs .distribution added to the end. But that made no difference.
>>
>> I am going to try on another machine to get the modules built.
>
> Try building from the top-level and adding the "package" goal:
>
> $ mvn -Pcommons-rng examples clean package
Correct.
Somehow in repeat attempts at doing this I dropped the packaging of the code, so obviously it cannot find the module-info when building the JPMS sub-modules since there are no jars in the other sub-module dependencies. At various testing points I had ‘install’ in my mvn command so that worked but I kept going back to the wrong command to build from clean. However I learnt a lot today about Java 9 modules when trying to understand what was wrong so it was useful for me.
So the current master branch does build and does create the java docs with the MathJax script. My previous jdk9 version was too old. Recent versions work. Case closed.
Alex
>
> Gilles
>
>>>> [...]
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [Rng] README.md and broken javadoc link
Posted by Gilles Sadowski <gi...@gmail.com>.
Hi.
Le lun. 18 févr. 2019 à 16:22, Alex Herbert <al...@gmail.com> a écrit :
>
>>> [...]
> >
> > Command
> > $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
> > -Pcommons-rng-examples -Pjdk8-javadoc clean package site site:stage
> > works on
> > $ /usr/lib/jvm/java-9-openjdk-amd64/bin/java -version
> > openjdk version "9-Debian"
> > OpenJDK Runtime Environment (build 9-Debian+0-9b181-4bpo91)
> > OpenJDK 64-Bit Server VM (build 9-Debian+0-9b181-4bpo91, mixed mode)
> >
> > I missed when the "jdk8-javadoc" profile became mandatory. Is there a
> > way to have it activated automatically when necessary (e.g. when compiling
> > with a JKD >= 8)?
> >
> > Gilles
>
> I’ve removed the linux distribution version of OpenJDK 9 and manually installed OpenJDK 9, 10 and 11.
>
> I confirm these versions all require the --allow-script-in-comments option for 'mvn javadoc:javadoc'. So I’ve reverted the pom.xml to put this back in the profile for JDK 1.8+.
>
> I get a module error when building on OpenJDK 9:
>
> mvn -v
> Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
> Maven home: /usr/local/apache-maven-3.5.4
> Java version: 9, vendor: Oracle Corporation, runtime: /usr/lib/jvm/jdk-9
> Default locale: en_GB, platform encoding: UTF-8
> OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: “unix"
>
> mvn clean site site:stage -Pcommons-rng-exampless
>
> [INFO] Reactor Summary:
> [INFO]
> [INFO] Apache Commons RNG 1.3-SNAPSHOT .................... SUCCESS [ 13.143 s]
> [INFO] Apache Commons RNG Client API ...................... SUCCESS [ 8.144 s]
> [INFO] Apache Commons RNG Core ............................ SUCCESS [ 19.623 s]
> [INFO] Apache Commons RNG Simple .......................... SUCCESS [ 13.773 s]
> [INFO] Apache Commons RNG Sampling ........................ SUCCESS [01:07 min]
> [INFO] Apache Commons RNG Examples ........................ SUCCESS [ 3.871 s]
> [INFO] Stress test example ................................ SUCCESS [ 6.715 s]
> [INFO] Sampling example ................................... SUCCESS [ 6.155 s]
> [INFO] Quadrature example ................................. SUCCESS [ 5.808 s]
> [INFO] JMH Benchmark ...................................... SUCCESS [ 22.310 s]
> [INFO] JPMS Integration test .............................. SUCCESS [ 1.895 s]
> [INFO] JPMS module example (library) ...................... FAILURE [ 0.559 s]
> [INFO] JPMS module example (application) 1.3-SNAPSHOT ..... SKIPPED
> [INFO] ------------------------------------------------------------------------
> [INFO] BUILD FAILURE
> [INFO] ------------------------------------------------------------------------
> [INFO] Total time: 02:49 min
> [INFO] Finished at: 2019-02-18T13:54:01Z
> [INFO] ------------------------------------------------------------------------
> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site) on project commons-rng-examples-jpms-lib: failed to get report for org.apache.maven.plugins:maven-surefire-report-plugin: Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.7.0:compile (default-compile) on project commons-rng-examples-jpms-lib: Compilation failure: Compilation failure:
> [ERROR] /home/ah403/git/commons-rng/commons-rng-examples/examples-jpms/jpms-lib/src/main/java/module-info.java:[18,36] module not found: org.apache.commons.rng.api
> [ERROR] /home/ah403/git/commons-rng/commons-rng-examples/examples-jpms/jpms-lib/src/main/java/module-info.java:[19,36] module not found: org.apache.commons.rng.sampling
>
>
> I tried mvn 3.5.4 and 3.6.0.
>
> This can be reduced to just running:
>
> mvn compile in commons-rng-examples/examples-jpms
Works here (maven downloads the "1.3-SNAPSHOT" artefacts from the
Apache repository).
>
> Something about this machine setup does not like the modules setup. I had a dig around and thought updating this module definition would work:
>
> module org.apache.commons.rng.examples.jpms.lib {
> requires org.apache.commons.rng;
> requires org.apache.commons.rng.sampling.distribution;
> exports org.apache.commons.rng.examples.jpms.lib;
> }
>
> The module currently requires ‘o.a.c.rng.api’ which doesn’t exist and ‘o.a.c.rng.sampling’ which needs .distribution added to the end. But that made no difference.
>
> I am going to try on another machine to get the modules built.
Try building from the top-level and adding the "package" goal:
$ mvn -Pcommons-rng examples clean package
Gilles
>>> [...]
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [Rng] README.md and broken javadoc link
Posted by Alex Herbert <al...@gmail.com>.
> On 17 Feb 2019, at 23:25, Gilles Sadowski <gi...@gmail.com> wrote:
>
> Hello.
>
> Le dim. 17 févr. 2019 à 23:57, Alex Herbert <alex.d.herbert@gmail.com <ma...@gmail.com>> a écrit :
>>
>> Hi Gilles,
>>
>> This is related to the fix I made for MathJax. It apparently is not as simple as I thought, i.e. this was a hidden tag only for JDK 8. This tag is not officially documented so there is no official solution, only what you can find on the web.
>>
>> I had installed openJDK 9 on my linux machine to test building the JMS modules. I had to remove the --allow-script-in-comments tag to get it to build the javadocs. So I changed the latest pom.xml for commons-rng-parent to only add the tag on JDK 1.8. I found that if I had that tag on open JDK 9 the following fails:
>>
>> mvn -v
>> Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
>> Maven home: /usr/local/apache-maven-3.5.4
>> Java version: 9-internal, vendor: Oracle Corporation, runtime: /usr/lib/jvm/java-9-openjdk-amd64
>> Default locale: en_GB, platform encoding: UTF-8
>> OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: "unix"
>>
>> java -version
>> openjdk version "9-internal"
>> OpenJDK Runtime Environment (build 9-internal+0-2016-04-14-195246.buildd.src)
>> OpenJDK 64-Bit Server VM (build 9-internal+0-2016-04-14-195246.buildd.src, mixed mode)
>>
>> mvn javadoc:javadoc
>>
>> Is OK.
>>
>> mvn javadoc:javadoc -Pjdk8-javadoc
>>
>> Does NOT work.
>>
>> I have just tried:
>>
>> mvn clean site site:stage -Pcommons-rng-examples
>>
>> This is fails on the client-api module with this weird error running the findbugs report:
>>
>> [INFO] Fork Value is true
>> [java] Exception in thread "main" java.io.IOException: IOException while scanning codebases
>> [java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:282)
>> [java] at edu.umd.cs.findbugs.FindBugs.runMain(FindBugs.java:401)
>> [java] at edu.umd.cs.findbugs.FindBugs2.main(FindBugs2.java:1187)
>> [java] Caused by: edu.umd.cs.findbugs.classfile.ResourceNotFoundException: Resource not found: java/lang/Object.class
>> [java] at edu.umd.cs.findbugs.classfile.impl.ClassPathImpl.lookupResource(ClassPathImpl.java:164)
>> [java] at edu.umd.cs.findbugs.classfile.impl.ClassPathBuilder.build(ClassPathBuilder.java:282)
>> [java] at edu.umd.cs.findbugs.FindBugs2.buildClassPath(FindBugs2.java:674)
>> [java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:215)
>> [java] ... 2 more
>>
>> So the I am thinking the jdk9 install I am using is broken and probably too old to have the hidden --allow-script-in-comments option for javadoc.
>>
>> You could try running with the 'jdk8-javadoc’ profile on your java 9 and see if that fixes the problem for you.
>>
>> Can you let me know what version of java 9 you are using?
>
> Command
> $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
> -Pcommons-rng-examples -Pjdk8-javadoc clean package site site:stage
> works on
> $ /usr/lib/jvm/java-9-openjdk-amd64/bin/java -version
> openjdk version "9-Debian"
> OpenJDK Runtime Environment (build 9-Debian+0-9b181-4bpo91)
> OpenJDK 64-Bit Server VM (build 9-Debian+0-9b181-4bpo91, mixed mode)
>
> I missed when the "jdk8-javadoc" profile became mandatory. Is there a
> way to have it activated automatically when necessary (e.g. when compiling
> with a JKD >= 8)?
>
> Gilles
I’ve removed the linux distribution version of OpenJDK 9 and manually installed OpenJDK 9, 10 and 11.
I confirm these versions all require the --allow-script-in-comments option for 'mvn javadoc:javadoc'. So I’ve reverted the pom.xml to put this back in the profile for JDK 1.8+.
I get a module error when building on OpenJDK 9:
mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
Maven home: /usr/local/apache-maven-3.5.4
Java version: 9, vendor: Oracle Corporation, runtime: /usr/lib/jvm/jdk-9
Default locale: en_GB, platform encoding: UTF-8
OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: “unix"
mvn clean site site:stage -Pcommons-rng-exampless
[INFO] Reactor Summary:
[INFO]
[INFO] Apache Commons RNG 1.3-SNAPSHOT .................... SUCCESS [ 13.143 s]
[INFO] Apache Commons RNG Client API ...................... SUCCESS [ 8.144 s]
[INFO] Apache Commons RNG Core ............................ SUCCESS [ 19.623 s]
[INFO] Apache Commons RNG Simple .......................... SUCCESS [ 13.773 s]
[INFO] Apache Commons RNG Sampling ........................ SUCCESS [01:07 min]
[INFO] Apache Commons RNG Examples ........................ SUCCESS [ 3.871 s]
[INFO] Stress test example ................................ SUCCESS [ 6.715 s]
[INFO] Sampling example ................................... SUCCESS [ 6.155 s]
[INFO] Quadrature example ................................. SUCCESS [ 5.808 s]
[INFO] JMH Benchmark ...................................... SUCCESS [ 22.310 s]
[INFO] JPMS Integration test .............................. SUCCESS [ 1.895 s]
[INFO] JPMS module example (library) ...................... FAILURE [ 0.559 s]
[INFO] JPMS module example (application) 1.3-SNAPSHOT ..... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 02:49 min
[INFO] Finished at: 2019-02-18T13:54:01Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site) on project commons-rng-examples-jpms-lib: failed to get report for org.apache.maven.plugins:maven-surefire-report-plugin: Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.7.0:compile (default-compile) on project commons-rng-examples-jpms-lib: Compilation failure: Compilation failure:
[ERROR] /home/ah403/git/commons-rng/commons-rng-examples/examples-jpms/jpms-lib/src/main/java/module-info.java:[18,36] module not found: org.apache.commons.rng.api
[ERROR] /home/ah403/git/commons-rng/commons-rng-examples/examples-jpms/jpms-lib/src/main/java/module-info.java:[19,36] module not found: org.apache.commons.rng.sampling
I tried mvn 3.5.4 and 3.6.0.
This can be reduced to just running:
mvn compile in commons-rng-examples/examples-jpms
Something about this machine setup does not like the modules setup. I had a dig around and thought updating this module definition would work:
module org.apache.commons.rng.examples.jpms.lib {
requires org.apache.commons.rng;
requires org.apache.commons.rng.sampling.distribution;
exports org.apache.commons.rng.examples.jpms.lib;
}
The module currently requires ‘o.a.c.rng.api’ which doesn’t exist and ‘o.a.c.rng.sampling’ which needs .distribution added to the end. But that made no difference.
I am going to try on another machine to get the modules built.
Alex
>
>>
>> Alex
>>
>>
>>> On 17 Feb 2019, at 22:03, Gilles Sadowski <gi...@gmail.com> wrote:
>>>
>>> Hi Alex.
>>>
>>> I tried to regenerate the site but the build fails:
>>> ---CUT---
>>> [INFO] Reactor Summary:
>>> [INFO]
>>> [INFO] Apache Commons RNG ................................. SUCCESS [ 21.050 s]
>>> [INFO] Apache Commons RNG Client API ...................... FAILURE [ 7.723 s]
>>> [INFO] Apache Commons RNG Core ............................ SKIPPED
>>> [INFO] Apache Commons RNG Simple .......................... SKIPPED
>>> [INFO] Apache Commons RNG Sampling ........................ SKIPPED
>>> [INFO] Apache Commons RNG Examples ........................ SKIPPED
>>> [INFO] Stress test example ................................ SKIPPED
>>> [INFO] Sampling example ................................... SKIPPED
>>> [INFO] Quadrature example ................................. SKIPPED
>>> [INFO] JMH Benchmark ...................................... SKIPPED
>>> [INFO] JPMS Integration test .............................. SKIPPED
>>> [INFO] JPMS module example (library) ...................... SKIPPED
>>> [INFO] JPMS module example (application) .................. SKIPPED
>>> [INFO] ------------------------------------------------------------------------
>>> [INFO] BUILD FAILURE
>>> [INFO] ------------------------------------------------------------------------
>>> [INFO] Total time: 29.294 s
>>> [INFO] Finished at: 2019-02-17T22:52:17+01:00
>>> [INFO] Final Memory: 82M/220M
>>> [INFO] ------------------------------------------------------------------------
>>> [ERROR] Failed to execute goal
>>> org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site)
>>> on project commons-rng-client-api: Error generating
>>> maven-javadoc-plugin:3.0.1:javadoc report:
>>> [ERROR] Exit code: 1 - javadoc: error - option -header contains JavaScript.
>>> [ERROR] Use --allow-script-in-comments to allow use of JavaScript.
>>> [ERROR]
>>> [ERROR] Command line was:
>>> /usr/lib/jvm/java-9-openjdk-amd64/bin/javadoc @options @package
>>> ---CUT---
>>>
>>> Command line was:
>>> $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
>>> -Pcommons-rng-examples clean site site:stage
>>>
>>> Regards,
>>> Gilles
>>>
>>> P.S. I'd wait for the new RNG implementations to be in "master" before
>>> updating the
>>> live site (so that "current" will refer to "1.3-SNAPSHOT").
>>>
>>>
>>> Le dim. 17 févr. 2019 à 16:08, Alex Herbert <alex.d.herbert@gmail.com <ma...@gmail.com> <mailto:alex.d.herbert@gmail.com <ma...@gmail.com>>> a écrit :
>>>>
>>>>
>>>>
>>>>> On 16 Feb 2019, at 21:31, Gilles Sadowski <gilleseran@gmail.com <ma...@gmail.com>> wrote:
>>>>>
>>>>> Hello.
>>>>>
>>>>> Le sam. 16 févr. 2019 à 13:12, Alex Herbert <alex.d.herbert@gmail.com <ma...@gmail.com>> a écrit :
>>>>>>
>>>>>> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
>>>>>>
>>>>>> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
>>>>>>
>>>>>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>>
>>>>>>
>>>>>> Given the use of sub-modules it appears the output README.md files have to be tweaked.
>>>>>>
>>>>>> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>.
>>>>>
>>>>> I don't see those links: the apidocs are hosted on the Apache server:
>>>>> https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html> <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>> <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html> <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>>>
>>>>
>>>> The javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> <http://javadoc.io/ <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>> badges are put at the top of the README.md by the latest commons build plugin. It seems that when you visit javadoc.io <http://javadoc.io/><http://javadoc.io/ <http://javadoc.io/>> <http://javadoc.io/ <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>> at the link this prompts them to get the public release and then create the javadoc pages on this site. All the badges I have tested do eventually build and show javadoc.
>>>>
>>>> The latest README.md updates the badges so that:
>>>>
>>>> - build status badge drops the '?branch=master’ parameter
>>>> - coverage badge drops the '?branch=master’ parameter
>>>> - maven central badge is unchanged *
>>>> - The licence badge is dropped
>>>> - The java docs badge is added to refer to javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> <http://javadoc.io/ <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>>
>>>>
>>>> * This badge used the artefact name so has to be updated for the main README.md page as that refers to commons-rng-parent. All the sub-modules are OK. I just pointed it to commons-ring-simple.
>>>>
>>>> So should the javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> <http://javadoc.io/ <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>> badge be dropped and the licence badge reinstated manually?
>>>>
>>>>>
>>>>>> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/> <https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>> <https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/> <https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>>>?
>>>>>
>>>>> It doesn't bother me that there is no aggregate Javadoc; the modules can be
>>>>> seen as separate libraries with different target audiences.
>>>>> The broken link in README.md should be replaced by links to the each of the
>>>>> modules.
>>>>>
>>>>> Regards,
>>>>> Gilles
>>>>
>>>> OK. I have tweaked the output from the commons build plugin for the main page to add javadoc links for client-api, core, simple and sampling.
>>>>
>>>> I updated all the other README.md files to:
>>>>
>>>> - manually fix the javadoc link in the modules with javadoc *
>>>> - not refer to the module name but ‘Apache Commons RNG’ for the donate link.
>>>> - use <commons.componentid>rng</commons.componentid> as the example property
>>>> - drop the RNG from the auto-generated [Apache Commons RNG homepage](https://commons.apache.org/ <https://commons.apache.org/> <https://commons.apache.org/ <https://commons.apache.org/>>)
>>>>
>>>> * The javadoc here:
>>>> https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/> <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>> <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/> <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>>>
>>>> Is for 1.1-SNAPSHOT. Some modules are missing (e.g. commons-ring-examples-quadrature).
>>>>
>>>> So the 1.2 release did not deploy apidocs for commons-examples? I do not know how to browse the hosting server to check. If missing then the apidocs should be fixed (uploaded). If it is not official to host these I can update the README.md to remove the browse link.
>>>>
>>>> You can see the latest comparison with what was previously in the README at this link:
>>>>
>>>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>>>
>>>>
>>>> You can view the pages here:
>>>>
>>>> https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme> <https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>> <https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme><https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>>>
>>>>
>>>> I think all the links work in all the modules except the missing javadocs for the commons-examples modules.
>>>>
>>>> The badges, [Contributing], [License] and [Additional Resource] sections are all now up-to-date with the latest from the commons build plugin. The latest description from the pom.xml is also included.
>>>>
>>>>
>>>>
>>>>
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org <ma...@commons.apache.org> <mailto:dev-unsubscribe@commons.apache.org <ma...@commons.apache.org>>
>>> For additional commands, e-mail: dev-help@commons.apache.org <ma...@commons.apache.org> <mailto:dev-help@commons.apache.org <ma...@commons.apache.org>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org <ma...@commons.apache.org>
> For additional commands, e-mail: dev-help@commons.apache.org <ma...@commons.apache.org>
Re: [Rng] README.md and broken javadoc link
Posted by Gilles Sadowski <gi...@gmail.com>.
Hello.
Le dim. 17 févr. 2019 à 23:57, Alex Herbert <al...@gmail.com> a écrit :
>
> Hi Gilles,
>
> This is related to the fix I made for MathJax. It apparently is not as simple as I thought, i.e. this was a hidden tag only for JDK 8. This tag is not officially documented so there is no official solution, only what you can find on the web.
>
> I had installed openJDK 9 on my linux machine to test building the JMS modules. I had to remove the --allow-script-in-comments tag to get it to build the javadocs. So I changed the latest pom.xml for commons-rng-parent to only add the tag on JDK 1.8. I found that if I had that tag on open JDK 9 the following fails:
>
> mvn -v
> Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
> Maven home: /usr/local/apache-maven-3.5.4
> Java version: 9-internal, vendor: Oracle Corporation, runtime: /usr/lib/jvm/java-9-openjdk-amd64
> Default locale: en_GB, platform encoding: UTF-8
> OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: "unix"
>
> java -version
> openjdk version "9-internal"
> OpenJDK Runtime Environment (build 9-internal+0-2016-04-14-195246.buildd.src)
> OpenJDK 64-Bit Server VM (build 9-internal+0-2016-04-14-195246.buildd.src, mixed mode)
>
> mvn javadoc:javadoc
>
> Is OK.
>
> mvn javadoc:javadoc -Pjdk8-javadoc
>
> Does NOT work.
>
> I have just tried:
>
> mvn clean site site:stage -Pcommons-rng-examples
>
> This is fails on the client-api module with this weird error running the findbugs report:
>
> [INFO] Fork Value is true
> [java] Exception in thread "main" java.io.IOException: IOException while scanning codebases
> [java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:282)
> [java] at edu.umd.cs.findbugs.FindBugs.runMain(FindBugs.java:401)
> [java] at edu.umd.cs.findbugs.FindBugs2.main(FindBugs2.java:1187)
> [java] Caused by: edu.umd.cs.findbugs.classfile.ResourceNotFoundException: Resource not found: java/lang/Object.class
> [java] at edu.umd.cs.findbugs.classfile.impl.ClassPathImpl.lookupResource(ClassPathImpl.java:164)
> [java] at edu.umd.cs.findbugs.classfile.impl.ClassPathBuilder.build(ClassPathBuilder.java:282)
> [java] at edu.umd.cs.findbugs.FindBugs2.buildClassPath(FindBugs2.java:674)
> [java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:215)
> [java] ... 2 more
>
> So the I am thinking the jdk9 install I am using is broken and probably too old to have the hidden --allow-script-in-comments option for javadoc.
>
> You could try running with the 'jdk8-javadoc’ profile on your java 9 and see if that fixes the problem for you.
>
> Can you let me know what version of java 9 you are using?
Command
$ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
-Pcommons-rng-examples -Pjdk8-javadoc clean package site site:stage
works on
$ /usr/lib/jvm/java-9-openjdk-amd64/bin/java -version
openjdk version "9-Debian"
OpenJDK Runtime Environment (build 9-Debian+0-9b181-4bpo91)
OpenJDK 64-Bit Server VM (build 9-Debian+0-9b181-4bpo91, mixed mode)
I missed when the "jdk8-javadoc" profile became mandatory. Is there a
way to have it activated automatically when necessary (e.g. when compiling
with a JKD >= 8)?
Gilles
>
> Alex
>
>
> > On 17 Feb 2019, at 22:03, Gilles Sadowski <gi...@gmail.com> wrote:
> >
> > Hi Alex.
> >
> > I tried to regenerate the site but the build fails:
> > ---CUT---
> > [INFO] Reactor Summary:
> > [INFO]
> > [INFO] Apache Commons RNG ................................. SUCCESS [ 21.050 s]
> > [INFO] Apache Commons RNG Client API ...................... FAILURE [ 7.723 s]
> > [INFO] Apache Commons RNG Core ............................ SKIPPED
> > [INFO] Apache Commons RNG Simple .......................... SKIPPED
> > [INFO] Apache Commons RNG Sampling ........................ SKIPPED
> > [INFO] Apache Commons RNG Examples ........................ SKIPPED
> > [INFO] Stress test example ................................ SKIPPED
> > [INFO] Sampling example ................................... SKIPPED
> > [INFO] Quadrature example ................................. SKIPPED
> > [INFO] JMH Benchmark ...................................... SKIPPED
> > [INFO] JPMS Integration test .............................. SKIPPED
> > [INFO] JPMS module example (library) ...................... SKIPPED
> > [INFO] JPMS module example (application) .................. SKIPPED
> > [INFO] ------------------------------------------------------------------------
> > [INFO] BUILD FAILURE
> > [INFO] ------------------------------------------------------------------------
> > [INFO] Total time: 29.294 s
> > [INFO] Finished at: 2019-02-17T22:52:17+01:00
> > [INFO] Final Memory: 82M/220M
> > [INFO] ------------------------------------------------------------------------
> > [ERROR] Failed to execute goal
> > org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site)
> > on project commons-rng-client-api: Error generating
> > maven-javadoc-plugin:3.0.1:javadoc report:
> > [ERROR] Exit code: 1 - javadoc: error - option -header contains JavaScript.
> > [ERROR] Use --allow-script-in-comments to allow use of JavaScript.
> > [ERROR]
> > [ERROR] Command line was:
> > /usr/lib/jvm/java-9-openjdk-amd64/bin/javadoc @options @package
> > ---CUT---
> >
> > Command line was:
> > $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
> > -Pcommons-rng-examples clean site site:stage
> >
> > Regards,
> > Gilles
> >
> > P.S. I'd wait for the new RNG implementations to be in "master" before
> > updating the
> > live site (so that "current" will refer to "1.3-SNAPSHOT").
> >
> >
> > Le dim. 17 févr. 2019 à 16:08, Alex Herbert <alex.d.herbert@gmail.com <ma...@gmail.com>> a écrit :
> >>
> >>
> >>
> >>> On 16 Feb 2019, at 21:31, Gilles Sadowski <gi...@gmail.com> wrote:
> >>>
> >>> Hello.
> >>>
> >>> Le sam. 16 févr. 2019 à 13:12, Alex Herbert <al...@gmail.com> a écrit :
> >>>>
> >>>> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
> >>>>
> >>>> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
> >>>>
> >>>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
> >>>>
> >>>> Given the use of sub-modules it appears the output README.md files have to be tweaked.
> >>>>
> >>>> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>.
> >>>
> >>> I don't see those links: the apidocs are hosted on the Apache server:
> >>> https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html> <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>>
> >>
> >> The javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> badges are put at the top of the README.md by the latest commons build plugin. It seems that when you visit javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> at the link this prompts them to get the public release and then create the javadoc pages on this site. All the badges I have tested do eventually build and show javadoc.
> >>
> >> The latest README.md updates the badges so that:
> >>
> >> - build status badge drops the '?branch=master’ parameter
> >> - coverage badge drops the '?branch=master’ parameter
> >> - maven central badge is unchanged *
> >> - The licence badge is dropped
> >> - The java docs badge is added to refer to javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>
> >>
> >> * This badge used the artefact name so has to be updated for the main README.md page as that refers to commons-rng-parent. All the sub-modules are OK. I just pointed it to commons-ring-simple.
> >>
> >> So should the javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> badge be dropped and the licence badge reinstated manually?
> >>
> >>>
> >>>> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/> <https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>>?
> >>>
> >>> It doesn't bother me that there is no aggregate Javadoc; the modules can be
> >>> seen as separate libraries with different target audiences.
> >>> The broken link in README.md should be replaced by links to the each of the
> >>> modules.
> >>>
> >>> Regards,
> >>> Gilles
> >>
> >> OK. I have tweaked the output from the commons build plugin for the main page to add javadoc links for client-api, core, simple and sampling.
> >>
> >> I updated all the other README.md files to:
> >>
> >> - manually fix the javadoc link in the modules with javadoc *
> >> - not refer to the module name but ‘Apache Commons RNG’ for the donate link.
> >> - use <commons.componentid>rng</commons.componentid> as the example property
> >> - drop the RNG from the auto-generated [Apache Commons RNG homepage](https://commons.apache.org/ <https://commons.apache.org/>)
> >>
> >> * The javadoc here:
> >> https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/> <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>>
> >> Is for 1.1-SNAPSHOT. Some modules are missing (e.g. commons-ring-examples-quadrature).
> >>
> >> So the 1.2 release did not deploy apidocs for commons-examples? I do not know how to browse the hosting server to check. If missing then the apidocs should be fixed (uploaded). If it is not official to host these I can update the README.md to remove the browse link.
> >>
> >> You can see the latest comparison with what was previously in the README at this link:
> >>
> >> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>>
> >>
> >> You can view the pages here:
> >>
> >> https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme> <https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>>
> >>
> >> I think all the links work in all the modules except the missing javadocs for the commons-examples modules.
> >>
> >> The badges, [Contributing], [License] and [Additional Resource] sections are all now up-to-date with the latest from the commons build plugin. The latest description from the pom.xml is also included.
> >>
> >>
> >>
> >>
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org <ma...@commons.apache.org>
> > For additional commands, e-mail: dev-help@commons.apache.org <ma...@commons.apache.org>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [Rng] README.md and broken javadoc link
Posted by Alex Herbert <al...@gmail.com>.
Hi Gilles,
This is related to the fix I made for MathJax. It apparently is not as simple as I thought, i.e. this was a hidden tag only for JDK 8. This tag is not officially documented so there is no official solution, only what you can find on the web.
I had installed openJDK 9 on my linux machine to test building the JMS modules. I had to remove the --allow-script-in-comments tag to get it to build the javadocs. So I changed the latest pom.xml for commons-rng-parent to only add the tag on JDK 1.8. I found that if I had that tag on open JDK 9 the following fails:
mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T19:33:14+01:00)
Maven home: /usr/local/apache-maven-3.5.4
Java version: 9-internal, vendor: Oracle Corporation, runtime: /usr/lib/jvm/java-9-openjdk-amd64
Default locale: en_GB, platform encoding: UTF-8
OS name: "linux", version: "4.4.0-142-generic", arch: "amd64", family: "unix"
java -version
openjdk version "9-internal"
OpenJDK Runtime Environment (build 9-internal+0-2016-04-14-195246.buildd.src)
OpenJDK 64-Bit Server VM (build 9-internal+0-2016-04-14-195246.buildd.src, mixed mode)
mvn javadoc:javadoc
Is OK.
mvn javadoc:javadoc -Pjdk8-javadoc
Does NOT work.
I have just tried:
mvn clean site site:stage -Pcommons-rng-examples
This is fails on the client-api module with this weird error running the findbugs report:
[INFO] Fork Value is true
[java] Exception in thread "main" java.io.IOException: IOException while scanning codebases
[java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:282)
[java] at edu.umd.cs.findbugs.FindBugs.runMain(FindBugs.java:401)
[java] at edu.umd.cs.findbugs.FindBugs2.main(FindBugs2.java:1187)
[java] Caused by: edu.umd.cs.findbugs.classfile.ResourceNotFoundException: Resource not found: java/lang/Object.class
[java] at edu.umd.cs.findbugs.classfile.impl.ClassPathImpl.lookupResource(ClassPathImpl.java:164)
[java] at edu.umd.cs.findbugs.classfile.impl.ClassPathBuilder.build(ClassPathBuilder.java:282)
[java] at edu.umd.cs.findbugs.FindBugs2.buildClassPath(FindBugs2.java:674)
[java] at edu.umd.cs.findbugs.FindBugs2.execute(FindBugs2.java:215)
[java] ... 2 more
So the I am thinking the jdk9 install I am using is broken and probably too old to have the hidden --allow-script-in-comments option for javadoc.
You could try running with the 'jdk8-javadoc’ profile on your java 9 and see if that fixes the problem for you.
Can you let me know what version of java 9 you are using?
Alex
> On 17 Feb 2019, at 22:03, Gilles Sadowski <gi...@gmail.com> wrote:
>
> Hi Alex.
>
> I tried to regenerate the site but the build fails:
> ---CUT---
> [INFO] Reactor Summary:
> [INFO]
> [INFO] Apache Commons RNG ................................. SUCCESS [ 21.050 s]
> [INFO] Apache Commons RNG Client API ...................... FAILURE [ 7.723 s]
> [INFO] Apache Commons RNG Core ............................ SKIPPED
> [INFO] Apache Commons RNG Simple .......................... SKIPPED
> [INFO] Apache Commons RNG Sampling ........................ SKIPPED
> [INFO] Apache Commons RNG Examples ........................ SKIPPED
> [INFO] Stress test example ................................ SKIPPED
> [INFO] Sampling example ................................... SKIPPED
> [INFO] Quadrature example ................................. SKIPPED
> [INFO] JMH Benchmark ...................................... SKIPPED
> [INFO] JPMS Integration test .............................. SKIPPED
> [INFO] JPMS module example (library) ...................... SKIPPED
> [INFO] JPMS module example (application) .................. SKIPPED
> [INFO] ------------------------------------------------------------------------
> [INFO] BUILD FAILURE
> [INFO] ------------------------------------------------------------------------
> [INFO] Total time: 29.294 s
> [INFO] Finished at: 2019-02-17T22:52:17+01:00
> [INFO] Final Memory: 82M/220M
> [INFO] ------------------------------------------------------------------------
> [ERROR] Failed to execute goal
> org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site)
> on project commons-rng-client-api: Error generating
> maven-javadoc-plugin:3.0.1:javadoc report:
> [ERROR] Exit code: 1 - javadoc: error - option -header contains JavaScript.
> [ERROR] Use --allow-script-in-comments to allow use of JavaScript.
> [ERROR]
> [ERROR] Command line was:
> /usr/lib/jvm/java-9-openjdk-amd64/bin/javadoc @options @package
> ---CUT---
>
> Command line was:
> $ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
> -Pcommons-rng-examples clean site site:stage
>
> Regards,
> Gilles
>
> P.S. I'd wait for the new RNG implementations to be in "master" before
> updating the
> live site (so that "current" will refer to "1.3-SNAPSHOT").
>
>
> Le dim. 17 févr. 2019 à 16:08, Alex Herbert <alex.d.herbert@gmail.com <ma...@gmail.com>> a écrit :
>>
>>
>>
>>> On 16 Feb 2019, at 21:31, Gilles Sadowski <gi...@gmail.com> wrote:
>>>
>>> Hello.
>>>
>>> Le sam. 16 févr. 2019 à 13:12, Alex Herbert <al...@gmail.com> a écrit :
>>>>
>>>> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
>>>>
>>>> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
>>>>
>>>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
>>>>
>>>> Given the use of sub-modules it appears the output README.md files have to be tweaked.
>>>>
>>>> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>.
>>>
>>> I don't see those links: the apidocs are hosted on the Apache server:
>>> https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html> <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>>
>>
>> The javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> badges are put at the top of the README.md by the latest commons build plugin. It seems that when you visit javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> at the link this prompts them to get the public release and then create the javadoc pages on this site. All the badges I have tested do eventually build and show javadoc.
>>
>> The latest README.md updates the badges so that:
>>
>> - build status badge drops the '?branch=master’ parameter
>> - coverage badge drops the '?branch=master’ parameter
>> - maven central badge is unchanged *
>> - The licence badge is dropped
>> - The java docs badge is added to refer to javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>>
>>
>> * This badge used the artefact name so has to be updated for the main README.md page as that refers to commons-rng-parent. All the sub-modules are OK. I just pointed it to commons-ring-simple.
>>
>> So should the javadoc.io <http://javadoc.io/> <http://javadoc.io/ <http://javadoc.io/>> badge be dropped and the licence badge reinstated manually?
>>
>>>
>>>> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/> <https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>>?
>>>
>>> It doesn't bother me that there is no aggregate Javadoc; the modules can be
>>> seen as separate libraries with different target audiences.
>>> The broken link in README.md should be replaced by links to the each of the
>>> modules.
>>>
>>> Regards,
>>> Gilles
>>
>> OK. I have tweaked the output from the commons build plugin for the main page to add javadoc links for client-api, core, simple and sampling.
>>
>> I updated all the other README.md files to:
>>
>> - manually fix the javadoc link in the modules with javadoc *
>> - not refer to the module name but ‘Apache Commons RNG’ for the donate link.
>> - use <commons.componentid>rng</commons.componentid> as the example property
>> - drop the RNG from the auto-generated [Apache Commons RNG homepage](https://commons.apache.org/ <https://commons.apache.org/>)
>>
>> * The javadoc here:
>> https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/> <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>>
>> Is for 1.1-SNAPSHOT. Some modules are missing (e.g. commons-ring-examples-quadrature).
>>
>> So the 1.2 release did not deploy apidocs for commons-examples? I do not know how to browse the hosting server to check. If missing then the apidocs should be fixed (uploaded). If it is not official to host these I can update the README.md to remove the browse link.
>>
>> You can see the latest comparison with what was previously in the README at this link:
>>
>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme> <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>>
>>
>> You can view the pages here:
>>
>> https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme> <https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>>
>>
>> I think all the links work in all the modules except the missing javadocs for the commons-examples modules.
>>
>> The badges, [Contributing], [License] and [Additional Resource] sections are all now up-to-date with the latest from the commons build plugin. The latest description from the pom.xml is also included.
>>
>>
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org <ma...@commons.apache.org>
> For additional commands, e-mail: dev-help@commons.apache.org <ma...@commons.apache.org>
Re: [Rng] README.md and broken javadoc link
Posted by Gilles Sadowski <gi...@gmail.com>.
Hi Alex.
I tried to regenerate the site but the build fails:
---CUT---
[INFO] Reactor Summary:
[INFO]
[INFO] Apache Commons RNG ................................. SUCCESS [ 21.050 s]
[INFO] Apache Commons RNG Client API ...................... FAILURE [ 7.723 s]
[INFO] Apache Commons RNG Core ............................ SKIPPED
[INFO] Apache Commons RNG Simple .......................... SKIPPED
[INFO] Apache Commons RNG Sampling ........................ SKIPPED
[INFO] Apache Commons RNG Examples ........................ SKIPPED
[INFO] Stress test example ................................ SKIPPED
[INFO] Sampling example ................................... SKIPPED
[INFO] Quadrature example ................................. SKIPPED
[INFO] JMH Benchmark ...................................... SKIPPED
[INFO] JPMS Integration test .............................. SKIPPED
[INFO] JPMS module example (library) ...................... SKIPPED
[INFO] JPMS module example (application) .................. SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 29.294 s
[INFO] Finished at: 2019-02-17T22:52:17+01:00
[INFO] Final Memory: 82M/220M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal
org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site)
on project commons-rng-client-api: Error generating
maven-javadoc-plugin:3.0.1:javadoc report:
[ERROR] Exit code: 1 - javadoc: error - option -header contains JavaScript.
[ERROR] Use --allow-script-in-comments to allow use of JavaScript.
[ERROR]
[ERROR] Command line was:
/usr/lib/jvm/java-9-openjdk-amd64/bin/javadoc @options @package
---CUT---
Command line was:
$ JAVA_HOME=/usr/lib/jvm/java-9-openjdk-amd64/ mvn
-Pcommons-rng-examples clean site site:stage
Regards,
Gilles
P.S. I'd wait for the new RNG implementations to be in "master" before
updating the
live site (so that "current" will refer to "1.3-SNAPSHOT").
Le dim. 17 févr. 2019 à 16:08, Alex Herbert <al...@gmail.com> a écrit :
>
>
>
> > On 16 Feb 2019, at 21:31, Gilles Sadowski <gi...@gmail.com> wrote:
> >
> > Hello.
> >
> > Le sam. 16 févr. 2019 à 13:12, Alex Herbert <al...@gmail.com> a écrit :
> >>
> >> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
> >>
> >> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
> >>
> >> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
> >>
> >> Given the use of sub-modules it appears the output README.md files have to be tweaked.
> >>
> >> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>.
> >
> > I don't see those links: the apidocs are hosted on the Apache server:
> > https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>
>
> The javadoc.io <http://javadoc.io/> badges are put at the top of the README.md by the latest commons build plugin. It seems that when you visit javadoc.io <http://javadoc.io/> at the link this prompts them to get the public release and then create the javadoc pages on this site. All the badges I have tested do eventually build and show javadoc.
>
> The latest README.md updates the badges so that:
>
> - build status badge drops the '?branch=master’ parameter
> - coverage badge drops the '?branch=master’ parameter
> - maven central badge is unchanged *
> - The licence badge is dropped
> - The java docs badge is added to refer to javadoc.io <http://javadoc.io/>
>
> * This badge used the artefact name so has to be updated for the main README.md page as that refers to commons-rng-parent. All the sub-modules are OK. I just pointed it to commons-ring-simple.
>
> So should the javadoc.io <http://javadoc.io/> badge be dropped and the licence badge reinstated manually?
>
> >
> >> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>?
> >
> > It doesn't bother me that there is no aggregate Javadoc; the modules can be
> > seen as separate libraries with different target audiences.
> > The broken link in README.md should be replaced by links to the each of the
> > modules.
> >
> > Regards,
> > Gilles
>
> OK. I have tweaked the output from the commons build plugin for the main page to add javadoc links for client-api, core, simple and sampling.
>
> I updated all the other README.md files to:
>
> - manually fix the javadoc link in the modules with javadoc *
> - not refer to the module name but ‘Apache Commons RNG’ for the donate link.
> - use <commons.componentid>rng</commons.componentid> as the example property
> - drop the RNG from the auto-generated [Apache Commons RNG homepage](https://commons.apache.org/)
>
> * The javadoc here:
> https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>
> Is for 1.1-SNAPSHOT. Some modules are missing (e.g. commons-ring-examples-quadrature).
>
> So the 1.2 release did not deploy apidocs for commons-examples? I do not know how to browse the hosting server to check. If missing then the apidocs should be fixed (uploaded). If it is not official to host these I can update the README.md to remove the browse link.
>
> You can see the latest comparison with what was previously in the README at this link:
>
> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
>
> You can view the pages here:
>
> https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>
>
> I think all the links work in all the modules except the missing javadocs for the commons-examples modules.
>
> The badges, [Contributing], [License] and [Additional Resource] sections are all now up-to-date with the latest from the commons build plugin. The latest description from the pom.xml is also included.
>
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [Rng] README.md and broken javadoc link
Posted by Alex Herbert <al...@gmail.com>.
> On 16 Feb 2019, at 21:31, Gilles Sadowski <gi...@gmail.com> wrote:
>
> Hello.
>
> Le sam. 16 févr. 2019 à 13:12, Alex Herbert <al...@gmail.com> a écrit :
>>
>> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
>>
>> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
>>
>> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
>>
>> Given the use of sub-modules it appears the output README.md files have to be tweaked.
>>
>> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>.
>
> I don't see those links: the apidocs are hosted on the Apache server:
> https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html <https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html>
The javadoc.io <http://javadoc.io/> badges are put at the top of the README.md by the latest commons build plugin. It seems that when you visit javadoc.io <http://javadoc.io/> at the link this prompts them to get the public release and then create the javadoc pages on this site. All the badges I have tested do eventually build and show javadoc.
The latest README.md updates the badges so that:
- build status badge drops the '?branch=master’ parameter
- coverage badge drops the '?branch=master’ parameter
- maven central badge is unchanged *
- The licence badge is dropped
- The java docs badge is added to refer to javadoc.io <http://javadoc.io/>
* This badge used the artefact name so has to be updated for the main README.md page as that refers to commons-rng-parent. All the sub-modules are OK. I just pointed it to commons-ring-simple.
So should the javadoc.io <http://javadoc.io/> badge be dropped and the licence badge reinstated manually?
>
>> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>?
>
> It doesn't bother me that there is no aggregate Javadoc; the modules can be
> seen as separate libraries with different target audiences.
> The broken link in README.md should be replaced by links to the each of the
> modules.
>
> Regards,
> Gilles
OK. I have tweaked the output from the commons build plugin for the main page to add javadoc links for client-api, core, simple and sampling.
I updated all the other README.md files to:
- manually fix the javadoc link in the modules with javadoc *
- not refer to the module name but ‘Apache Commons RNG’ for the donate link.
- use <commons.componentid>rng</commons.componentid> as the example property
- drop the RNG from the auto-generated [Apache Commons RNG homepage](https://commons.apache.org/)
* The javadoc here:
https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/ <https://commons.apache.org/proper/commons-rng/commons-rng-examples/apidocs/>
Is for 1.1-SNAPSHOT. Some modules are missing (e.g. commons-ring-examples-quadrature).
So the 1.2 release did not deploy apidocs for commons-examples? I do not know how to browse the hosting server to check. If missing then the apidocs should be fixed (uploaded). If it is not official to host these I can update the README.md to remove the browse link.
You can see the latest comparison with what was previously in the README at this link:
https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
You can view the pages here:
https://github.com/aherbert/commons-rng/tree/update-readme <https://github.com/aherbert/commons-rng/tree/update-readme>
I think all the links work in all the modules except the missing javadocs for the commons-examples modules.
The badges, [Contributing], [License] and [Additional Resource] sections are all now up-to-date with the latest from the commons build plugin. The latest description from the pom.xml is also included.
Re: [Rng] README.md and broken javadoc link
Posted by Gilles Sadowski <gi...@gmail.com>.
Hello.
Le sam. 16 févr. 2019 à 13:12, Alex Herbert <al...@gmail.com> a écrit :
>
> The link to the javadoc on the GitHub homepage is broken. I cannot find a link to the javadoc from the official commons RNG homepage.
>
> I have tried to update the README.md using the commons build plugin. Here is a comparison between updated and the original:
>
> https://github.com/apache/commons-rng/compare/master...aherbert:update-readme <https://github.com/apache/commons-rng/compare/master...aherbert:update-readme>
>
> Given the use of sub-modules it appears the output README.md files have to be tweaked.
>
> The build plugin creates working links for each of the sub-modules to javadoc.io <http://javadoc.io/>.
I don't see those links: the apidocs are hosted on the Apache server:
https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/overview-summary.html
> However should there be a master javadoc with bundles for each module hosted somewhere on https://commons.apache.org/proper/commons-rng/ <https://commons.apache.org/proper/commons-rng/>?
It doesn't bother me that there is no aggregate Javadoc; the modules can be
seen as separate libraries with different target audiences.
The broken link in README.md should be replaced by links to the each of the
modules.
Regards,
Gilles
>
> Alex
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org