You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Vincent Siveton (JIRA)" <ji...@codehaus.org> on 2008/08/12 13:03:28 UTC
[jira] Created: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
------------------------------------------------------------------------------------------------------------------
Key: MJAVADOC-212
URL: http://jira.codehaus.org/browse/MJAVADOC-212
Project: Maven 2.x Javadoc Plugin
Issue Type: Bug
Affects Versions: 2.5
Reporter: Vincent Siveton
Priority: Critical
Fix For: 2.5
In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
{code:title=AbstractJavadocMojo.java|borderStyle=solid}
if ( aggregate && !project.isExecutionRoot() )
{
return;
}
{code}
the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Closed: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton closed MJAVADOC-212.
------------------------------------
Assignee: Vincent Siveton
Resolution: Fixed
Patch applied in [r685691|http://svn.apache.org/viewvc?rev=685691&view=rev] and [r685692|http://svn.apache.org/viewvc?rev=685692&view=rev], snapshot deployed.
Thanks!
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Assignee: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
> Attachments: javadoc-aggregation.patch, MJAVADOC-212.patch
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=144847#action_144847 ]
Benjamin Bentmann commented on MJAVADOC-212:
--------------------------------------------
Considering the penalty of the forked lifecycles during the site generation of *every* module caused by "@aggregator" on the new mojos, I would however assume that people will sooner than later user {{<reportSets>}} to disable them from running in child modules.
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
> Attachments: javadoc-aggregation.patch, MJAVADOC-212.patch
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Issue Comment Edited: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=144846#action_144846 ]
bentmann edited comment on MJAVADOC-212 at 8/12/08 1:44 PM:
---------------------------------------------------------------------
Another idea: Currently, the parameter "aggregate" controls the aggregation behavior of say "javadoc:javadoc". However, this is not reliable, proper aggregation also requires to collectively fork all projects in the reactor. This can only be achieved via the "@aggregator" mojo annotation. So I believe the natural solution is to query the existence of this annotation whereever the code now checks the "aggregate" parameter. Hence, I added a new method {{isAggregator()}} that mojos override to report their aggregating behavior.
The existing parameter "aggregate" is kept only for convenience during the site lifecycle. The implementation of {{canGenerateReport()}} will skip those reports whose aggregator flag doesn't match the value specified by the user via "aggregate". This should allow to run either {{JavadocReport}} or {{AggregateJavadocReport}} without the need for {{<reportSets>}}. The parameter is ignored when the mojos are invoked via cli or build lifecycle, i.e. "mvn javadoc:javadoc -Daggregate=true" will no longer produce aggregated output. Instead, users should call "mvn javadoc:aggregate". That's a break, but I believe that's the only correct way in terms of proper aggregation.
I haven't tested this yet, it's merely a sketch for discussion.
was (Author: bentmann):
Another idea: Currently, the parameter "aggregate" controls the aggregation behavior of say "javadoc:javadoc". However, this is not reliable, proper aggregation also requires to collectively fork all projects in the reactor. This can only be achieved via the "@aggregator" mojo annotation. So I believe the natural solution is to query the existence of this annotation whereever the code now checks the "aggregate" parameter. Hence, I added a new method {{isAggregator()}} that mojos override to report their aggregating behavior.
The existing parameter "aggregate" is kept only for convenience during the site lifecycle. The implementation of {{canGenerateReport()}} will skip those reports whose aggregator flag doesn't match the value specified by the user via "aggregate". This should allow to run either {{JavadocReport}} or {{AggregateJavadocReport}} without the need for {{<reportSets>}}.
I haven't tested this yet, it's merely a sketch for discussion.
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
> Attachments: javadoc-aggregation.patch, MJAVADOC-212.patch
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=144792#action_144792 ]
Vincent Siveton commented on MJAVADOC-212:
------------------------------------------
A solution could be to move the aggregate parameter into AggregatorJavadocReport/AggregatorTestJavadocReport or to create a new parameter, like aggregator, only for these mojos.
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=144786#action_144786 ]
Vincent Siveton commented on MJAVADOC-212:
------------------------------------------
In fact, I noticed some warn like the following:
{noformat}
[INFO] Skipped "JavaDocs" report, file "apidocs/index.html" already exists for the English version.
{noformat}
So, AggregatorJavadocReport and JavadocReport are both used. It is normal IMHO since the PluginManager invokes all MavenReport.
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton updated MJAVADOC-212:
-------------------------------------
Fix Version/s: 2.5
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=144785#action_144785 ]
Vincent Siveton commented on MJAVADOC-212:
------------------------------------------
To reproduce it, go to plugin-tools or plugin-testing and run:
{noformat}
plugin-tools>mvn clean site:stage -DstagingDirectory=C:\target -X -Ddebug -Preporting
{noformat}
You will see an empty maven-plugin-tools-api\apidocs\index.html or maven-plugin-tools-api\testapidocs\index.html
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton updated MJAVADOC-212:
-------------------------------------
Attachment: MJAVADOC-212.patch
Proposed patch.
By default, AggregatorJavadocReport/AggregatorTestJavadocReport will never be called at least aggregator parameter is specified.
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
> Attachments: MJAVADOC-212.patch
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (MJAVADOC-212)
AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in
aggregator and no reports are generated
Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-212?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Benjamin Bentmann updated MJAVADOC-212:
---------------------------------------
Attachment: javadoc-aggregation.patch
Another idea: Currently, the parameter "aggregate" controls the aggregation behavior of say "javadoc:javadoc". However, this is not reliable, proper aggregation also requires to collectively fork all projects in the reactor. This can only be achieved via the "@aggregator" mojo annotation. So I believe the natural solution is to query the existence of this annotation whereever the code now checks the "aggregate" parameter. Hence, I added a new method {{isAggregator()}} that mojos override to report their aggregating behavior.
The existing parameter "aggregate" is kept only for convenience during the site lifecycle. The implementation of {{canGenerateReport()}} will skip those reports whose aggregator flag doesn't match the value specified by the user via "aggregate". This should allow to run either {{JavadocReport}} or {{AggregateJavadocReport}} without the need for {{<reportSets>}}.
I haven't tested this yet, it's merely a sketch for discussion.
> AggregatorJavadocReport/AggregatorTestJavadocReport are used by default in aggregator and no reports are generated
> ------------------------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-212
> URL: http://jira.codehaus.org/browse/MJAVADOC-212
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Vincent Siveton
> Priority: Critical
> Fix For: 2.5
>
> Attachments: javadoc-aggregation.patch, MJAVADOC-212.patch
>
>
> In multimodule way, AggregatorJavadocReport/AggregatorTestJavadocReport are used by default. Due to the following in the code,
> {code:title=AbstractJavadocMojo.java|borderStyle=solid}
> if ( aggregate && !project.isExecutionRoot() )
> {
> return;
> }
> {code}
> the report is skipped.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira