You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Carsten Ziegeler (JIRA)" <ji...@codehaus.org> on 2009/03/18 10:15:12 UTC
[jira] Created: (MJAVADOC-227) Aggregated javadocs do not take per
project configuration into account
Aggregated javadocs do not take per project configuration into account
----------------------------------------------------------------------
Key: MJAVADOC-227
URL: http://jira.codehaus.org/browse/MJAVADOC-227
Project: Maven 2.x Javadoc Plugin
Issue Type: Bug
Affects Versions: 2.5
Reporter: Carsten Ziegeler
We have a multi project setup where each module has a configuration for the javadocs for excluding packages.
Building the javadocs for each project separately works fine.
Starting the build from the root and building aggregated javadocs there, results in javadocs for all sources. The exclude package configurations of the individual poms are not considered.
I've used "javadoc:javadoc" to build the docs and tried both, putting the config in the plugin section and the reporting section in each module.
A workaround is of course to manually configure the javadoc plugin in the root pom and copy all excludes from the modules there; but that's a maintenance nightmare.
--
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-227) Aggregated javadocs do not take
per project configuration into account
Posted by "Carsten Ziegeler (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-227?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=183753#action_183753 ]
Carsten Ziegeler commented on MJAVADOC-227:
-------------------------------------------
Yes, we figured this out and it caused a lot of pain as this requires to add all configs from all sub modules to the parent pom as well. Imagine a project with > 100 modules all with different excludes - it's a nightmare :) That's why I filed the bug and the other reason is that the current behaviour wasn't the behaviour I expected.
I understand that there might be technical reasons, however, if the root project already knows all its subprojects (in order to aggregate), why can't it just aggregate the configs of the children first?
> Aggregated javadocs do not take per project configuration into account
> ----------------------------------------------------------------------
>
> Key: MJAVADOC-227
> URL: http://jira.codehaus.org/browse/MJAVADOC-227
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Carsten Ziegeler
>
> We have a multi project setup where each module has a configuration for the javadocs for excluding packages.
> Building the javadocs for each project separately works fine.
> Starting the build from the root and building aggregated javadocs there, results in javadocs for all sources. The exclude package configurations of the individual poms are not considered.
> I've used "javadoc:javadoc" to build the docs and tried both, putting the config in the plugin section and the reporting section in each module.
> A workaround is of course to manually configure the javadoc plugin in the root pom and copy all excludes from the modules there; but that's a maintenance nightmare.
--
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-227) Aggregated javadocs do not take
per project configuration into account
Posted by "Brian Fox (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-227?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=183722#action_183722 ]
Brian Fox commented on MJAVADOC-227:
------------------------------------
I'll add further clarification: The javadoc aggregate goal is, surprisingly, an aggregator. This means unlike normal goals that cause maven to iterate over each project, this one runs just once. It asks maven ahead of time to resolve all the projects in the reactor and it gets a list of them injected. The plugin configuration however comes from the project where it's being executed. Therefore, the configuration you have in all the sub modules is completely irrelevant as the only thing in context for configuration is the root project. If you want it to exclude certain things, you need to configure it here in the root or the plugin won't see it at all.
> Aggregated javadocs do not take per project configuration into account
> ----------------------------------------------------------------------
>
> Key: MJAVADOC-227
> URL: http://jira.codehaus.org/browse/MJAVADOC-227
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Carsten Ziegeler
>
> We have a multi project setup where each module has a configuration for the javadocs for excluding packages.
> Building the javadocs for each project separately works fine.
> Starting the build from the root and building aggregated javadocs there, results in javadocs for all sources. The exclude package configurations of the individual poms are not considered.
> I've used "javadoc:javadoc" to build the docs and tried both, putting the config in the plugin section and the reporting section in each module.
> A workaround is of course to manually configure the javadoc plugin in the root pom and copy all excludes from the modules there; but that's a maintenance nightmare.
--
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-227) Aggregated javadocs do not take per
project configuration into account
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-227?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton closed MJAVADOC-227.
------------------------------------
Resolution: Not A Bug
IIUC you want to run javadoc:aggregate from root and use the subproject plugin configuration: it is not possible (maven core) and I close it.
I suggest you to add properties to exclude your packages in the root and use them in the sub projects.
> Aggregated javadocs do not take per project configuration into account
> ----------------------------------------------------------------------
>
> Key: MJAVADOC-227
> URL: http://jira.codehaus.org/browse/MJAVADOC-227
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Reporter: Carsten Ziegeler
>
> We have a multi project setup where each module has a configuration for the javadocs for excluding packages.
> Building the javadocs for each project separately works fine.
> Starting the build from the root and building aggregated javadocs there, results in javadocs for all sources. The exclude package configurations of the individual poms are not considered.
> I've used "javadoc:javadoc" to build the docs and tried both, putting the config in the plugin section and the reporting section in each module.
> A workaround is of course to manually configure the javadoc plugin in the root pom and copy all excludes from the modules there; but that's a maintenance nightmare.
--
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