You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Robert Scholte <rf...@apache.org> on 2017/11/18 15:10:34 UTC

[VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Hi,

We solved 27 issues:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317529&version=12330875&styleName=Text

There are still a couple of issues left in JIRA:
https://issues.apache.org/jira/issues/?jql=project%20%3D%2012317529%20AND%20status%20%3D%20Open%20ORDER%20BY%20key%20DESC%2C%20priority%20DESC

Staging repo:
https://repository.apache.org/content/repositories/maven-1377/
https://repository.apache.org/content/repositories/maven-1377/org/apache/maven/plugins/maven-javadoc-plugin/3.0.0/maven-javadoc-plugin-3.0.0-source-release.zip

Source release checksum(s):
maven-javadoc-plugin-3.0.0-source-release.zip sha1:  
9f70c385b6be7666f35b5a24ede9c5c60e28dfce

Staging site:
https://maven.apache.org/plugins-archives/maven-javadoc-plugin-LATEST/

Guide to testing staged releases:
https://maven.apache.org/guides/development/guide-testing-releases.html

Vote open for at least 72 hours.

[ ] +1
[ ] +0
[ ] -1

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Mark Raynsford <or...@io7m.com>.
On 2017-11-18T17:44:23 +0100
Hervé BOUTEMY <he...@free.fr> wrote:

> JDK javadoc seems to cover the "aggregated javadocs" scenario: in Java 9 
> terms, that's "multi-modules" = exactly the case for JDK 9 javadoc [1]
> I don't know what's the command line to produce this, but looks feasible from 
> javadoc side
> 

It looked like a bug in the JavaDoc tool because the generation went
ahead and yet packages were placed into the wrong modules in the
output, but I think it might just be a matter of perspective. I think
the tool maybe worked correctly based on what it was given (a pile of
sources with some important module descriptors taken out).

-- 
Mark Raynsford | http://www.io7m.com

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Robert Scholte <rf...@apache.org>.
that works because OpenJDK uses module-source-path, i.e.  
src/<modulename>/<*.java>
Maven uses source-path because it matches exactly one module , i.e.  
src/main/java/<*.java>

Aggregator for modules requires to make use of module-source-paths.
I guess we need to consider to make use of symbolic links :(

thanks,
Robert

On Sat, 18 Nov 2017 17:44:23 +0100, Hervé BOUTEMY <he...@free.fr>  
wrote:

> JDK javadoc seems to cover the "aggregated javadocs" scenario: in Java 9
> terms, that's "multi-modules" = exactly the case for JDK 9 javadoc [1]
> I don't know what's the command line to produce this, but looks feasible  
> from
> javadoc side
>
> Regards,
>
> Hervé
>
> [1] https://docs.oracle.com/javase/9/docs/api/overview-summary.html
>
> Le samedi 18 novembre 2017, 17:38:23 CET Hervé BOUTEMY a écrit :
>> Le samedi 18 novembre 2017, 17:18:06 CET Mark Raynsford a écrit :
>> > On 2017-11-18T16:14:04 +0000
>> >
>> > Mark Raynsford <or...@io7m.com> wrote:
>> > > Presumably, with the module-info.java files
>> > > excluded, it reverts back to plain classpath style JavaDoc.
>> >
>> > Actually, it results in sort of weird looking JavaDoc that only
>> > contains a single module, and claims that all packages are in
>> >
>> > that module:
>> >   http://outland.iw.int.arc7.info/2017/11/18/apidocs/index.html
>> >
>> > That behaviour seems like it might be a bug in the actual JavaDoc tool
>> > itself.
>>
>> IIUC, javadoc does not cover aggregated javadocs scenario?
>>
>> I would not call that a bug, but a missing feature :)
>>
>> Regards,
>>
>> Hervé
>>
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Hervé BOUTEMY <he...@free.fr>.
JDK javadoc seems to cover the "aggregated javadocs" scenario: in Java 9 
terms, that's "multi-modules" = exactly the case for JDK 9 javadoc [1]
I don't know what's the command line to produce this, but looks feasible from 
javadoc side

Regards,

Hervé

[1] https://docs.oracle.com/javase/9/docs/api/overview-summary.html

Le samedi 18 novembre 2017, 17:38:23 CET Hervé BOUTEMY a écrit :
> Le samedi 18 novembre 2017, 17:18:06 CET Mark Raynsford a écrit :
> > On 2017-11-18T16:14:04 +0000
> > 
> > Mark Raynsford <or...@io7m.com> wrote:
> > > Presumably, with the module-info.java files
> > > excluded, it reverts back to plain classpath style JavaDoc.
> > 
> > Actually, it results in sort of weird looking JavaDoc that only
> > contains a single module, and claims that all packages are in
> > 
> > that module:
> >   http://outland.iw.int.arc7.info/2017/11/18/apidocs/index.html
> > 
> > That behaviour seems like it might be a bug in the actual JavaDoc tool
> > itself.
> 
> IIUC, javadoc does not cover aggregated javadocs scenario?
> 
> I would not call that a bug, but a missing feature :)
> 
> Regards,
> 
> Hervé
> 
> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Hervé BOUTEMY <he...@free.fr>.
Le samedi 18 novembre 2017, 17:18:06 CET Mark Raynsford a écrit :
> On 2017-11-18T16:14:04 +0000
> 
> Mark Raynsford <or...@io7m.com> wrote:
> > Presumably, with the module-info.java files
> > excluded, it reverts back to plain classpath style JavaDoc.
> 
> Actually, it results in sort of weird looking JavaDoc that only
> contains a single module, and claims that all packages are in
> that module:
> 
>   http://outland.iw.int.arc7.info/2017/11/18/apidocs/index.html
> 
> That behaviour seems like it might be a bug in the actual JavaDoc tool
> itself.
IIUC, javadoc does not cover aggregated javadocs scenario?

I would not call that a bug, but a missing feature :)

Regards,

Hervé




---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Mark Raynsford <or...@io7m.com>.
On 2017-11-18T16:14:04 +0000
Mark Raynsford <or...@io7m.com> wrote:
> Presumably, with the module-info.java files
> excluded, it reverts back to plain classpath style JavaDoc.

Actually, it results in sort of weird looking JavaDoc that only
contains a single module, and claims that all packages are in
that module:

  http://outland.iw.int.arc7.info/2017/11/18/apidocs/index.html

That behaviour seems like it might be a bug in the actual JavaDoc tool
itself.

-- 
Mark Raynsford | http://www.io7m.com

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Mark Raynsford <or...@io7m.com>.
On 2017-11-18T17:04:12 +0100
"Robert Scholte" <rf...@apache.org> wrote:

> That's similar to MJAVADOC-479[1]
> 
> Seems like all Java 9 issues are not resolved yet.
> I don't mind canceling the vote if we can fix this as well.
> 
> thanks,
> Robert
> 
> [1] https://issues.apache.org/jira/browse/MJAVADOC-479

Yeah, that does seem to be the one.

I think it'd be best to fix this. If I could apply a workaround, I'd
vote to release, but it seems that the workaround (excluding
module-info.java files) results in JavaDoc that doesn't contain any
module information. Presumably, with the module-info.java files
excluded, it reverts back to plain classpath style JavaDoc.

Your call!

-- 
Mark Raynsford | http://www.io7m.com

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Robert Scholte <rf...@apache.org>.
That's similar to MJAVADOC-479[1]

Seems like all Java 9 issues are not resolved yet.
I don't mind canceling the vote if we can fix this as well.

thanks,
Robert

[1] https://issues.apache.org/jira/browse/MJAVADOC-479

On Sat, 18 Nov 2017 16:57:36 +0100, Mark Raynsford  
<or...@io7m.com> wrote:

> Hello!
>
> I'd like to vote on this issue, but I still have a remaining problem
> and am not sure if it's because the plugin is broken due to the new
> module changes, or just because my project setup is slightly
> unusual.
>
> See here:
>
> https://github.com/io7m/maven-javadoc-bug-20171118
>
> The "c" module attempts to aggregate the javadoc of the other modules
> in the reactor into a single directory. It fails because the plugin
> attempts to load the module descriptors of the other projects,
> resulting in a "too many module descriptors" error.
>
> This is a simplified version of a real project here (all of my
> projects follow the same basic structure):
>
>   https://github.com/io7m/jequality
>
> The javadoc of all of the modules is aggregated into a directory and
> combined with some other documentation into a .zip for deployment.
>
> I'd could use the "aggregate" goal, but that causes too many problems
> due to the way that the goal forks and re-runs previous goals bound to
> the compile phase. Apart from anything, in larger projects with lots of
> modules, re-running all of those goals takes unacceptably long.
>
> It's not clear to me if this is actually a problem with the current
> plugin, or just because I'm not supposed to do things this way.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Mark Raynsford <or...@io7m.com>.
Hello!

I'd like to vote on this issue, but I still have a remaining problem
and am not sure if it's because the plugin is broken due to the new
module changes, or just because my project setup is slightly
unusual.

See here:

https://github.com/io7m/maven-javadoc-bug-20171118

The "c" module attempts to aggregate the javadoc of the other modules
in the reactor into a single directory. It fails because the plugin
attempts to load the module descriptors of the other projects,
resulting in a "too many module descriptors" error.

This is a simplified version of a real project here (all of my
projects follow the same basic structure):

  https://github.com/io7m/jequality

The javadoc of all of the modules is aggregated into a directory and
combined with some other documentation into a .zip for deployment.

I'd could use the "aggregate" goal, but that causes too many problems
due to the way that the goal forks and re-runs previous goals bound to
the compile phase. Apart from anything, in larger projects with lots of
modules, re-running all of those goals takes unacceptably long.

It's not clear to me if this is actually a problem with the current
plugin, or just because I'm not supposed to do things this way.

-- 
Mark Raynsford | http://www.io7m.com

[CANCELED] [VOTE] Release Apache Maven Javadoc Plugin version 3.0.0 (take 2)

Posted by Robert Scholte <rf...@apache.org>.
I'm going to cancel this vote.

The modules + aggregators is a valid find and it is quite easy to fix.
I'd prefer to add it for 3.0.0, otherwise others will hit it too.

Robert

On Sat, 18 Nov 2017 16:10:34 +0100, Robert Scholte <rf...@apache.org>  
wrote:

> Hi,
>
> We solved 27 issues:
> https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317529&version=12330875&styleName=Text
>
> There are still a couple of issues left in JIRA:
> https://issues.apache.org/jira/issues/?jql=project%20%3D%2012317529%20AND%20status%20%3D%20Open%20ORDER%20BY%20key%20DESC%2C%20priority%20DESC
>
> Staging repo:
> https://repository.apache.org/content/repositories/maven-1377/
> https://repository.apache.org/content/repositories/maven-1377/org/apache/maven/plugins/maven-javadoc-plugin/3.0.0/maven-javadoc-plugin-3.0.0-source-release.zip
>
> Source release checksum(s):
> maven-javadoc-plugin-3.0.0-source-release.zip sha1:  
> 9f70c385b6be7666f35b5a24ede9c5c60e28dfce
>
> Staging site:
> https://maven.apache.org/plugins-archives/maven-javadoc-plugin-LATEST/
>
> Guide to testing staged releases:
> https://maven.apache.org/guides/development/guide-testing-releases.html
>
> Vote open for at least 72 hours.
>
> [ ] +1
> [ ] +0
> [ ] -1
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org