[m2] How to "unregister" a report while being generated?

[Bellingard Fabrice <be...@gmail.com>]

Hi all,

While migrating a Maven plugin (taglist), I've encountered the following
case.

I have a root project with several Java modules. In my root project, I add
the taglist plugin in the reporting section so that every Java module can
have the report generated when "site:site" is called.
The problem is that when I do "m2 site:site" on my root project, the taglist
plugin is activated for the Java modules as well as for the root project.
But the root project as no source files, so the report should not exist
(that could also be the case if I had an Ear sub-module for instance). The
problem is that ${reports} in the "site.xml" file generates a link to this
report, may the report be generated or not.

I've looked to some other report plugins: the Javadoc plugin doesn't create
any files, so the link is broken, and the PMD plugin generates an almost
empty page, which is useless (when there's no source file, those kind of
plugins shouldn't do anything and should not be listed in the report
section).

Is there a way to handle that as for now? (like an API for unregistering the
report plugin so that it doesn't appear in the Reports menu) Or is it
currently a limitation?
Maybe I should not put the taglist plugin (and Javadoc and PMD) in the
reporting section of the root project, but then I would have to do it in
every module...

Cheers,
Fabrice.

Re: [m2] How to "unregister" a report while being generated?

[Brett Porter <br...@apache.org>]

Actually, I'll add my comments to MNG-945

Brett Porter wrote:

>Good point. We do need this. What should happen is the report have some
>way to indicate whether it generated something or not. It should always
>be called, but if there aren't any sources it shouldn't generate and the
>site plugin should not include it in the menu.
>
>Can you file it in JIRA?
>
>- Brett
>
>Bellingard Fabrice wrote:
>
>  
>
>>Hi all,
>>
>>While migrating a Maven plugin (taglist), I've encountered the following
>>case.
>>
>>I have a root project with several Java modules. In my root project, I add
>>the taglist plugin in the reporting section so that every Java module can
>>have the report generated when "site:site" is called.
>>The problem is that when I do "m2 site:site" on my root project, the taglist
>>plugin is activated for the Java modules as well as for the root project.
>>But the root project as no source files, so the report should not exist
>>(that could also be the case if I had an Ear sub-module for instance). The
>>problem is that ${reports} in the "site.xml" file generates a link to this
>>report, may the report be generated or not.
>>
>>I've looked to some other report plugins: the Javadoc plugin doesn't create
>>any files, so the link is broken, and the PMD plugin generates an almost
>>empty page, which is useless (when there's no source file, those kind of
>>plugins shouldn't do anything and should not be listed in the report
>>section).
>>
>>Is there a way to handle that as for now? (like an API for unregistering the
>>report plugin so that it doesn't appear in the Reports menu) Or is it
>>currently a limitation?
>>Maybe I should not put the taglist plugin (and Javadoc and PMD) in the
>>reporting section of the root project, but then I would have to do it in
>>every module...
>>
>>Cheers,
>>Fabrice.
>>
>> 
>>
>>    
>>
>
>---------------------------------------------------------------------
>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: [m2] How to "unregister" a report while being generated?

[Brett Porter <br...@apache.org>]

Good point. We do need this. What should happen is the report have some
way to indicate whether it generated something or not. It should always
be called, but if there aren't any sources it shouldn't generate and the
site plugin should not include it in the menu.

Can you file it in JIRA?

- Brett

Bellingard Fabrice wrote:

>Hi all,
>
>While migrating a Maven plugin (taglist), I've encountered the following
>case.
>
>I have a root project with several Java modules. In my root project, I add
>the taglist plugin in the reporting section so that every Java module can
>have the report generated when "site:site" is called.
>The problem is that when I do "m2 site:site" on my root project, the taglist
>plugin is activated for the Java modules as well as for the root project.
>But the root project as no source files, so the report should not exist
>(that could also be the case if I had an Ear sub-module for instance). The
>problem is that ${reports} in the "site.xml" file generates a link to this
>report, may the report be generated or not.
>
>I've looked to some other report plugins: the Javadoc plugin doesn't create
>any files, so the link is broken, and the PMD plugin generates an almost
>empty page, which is useless (when there's no source file, those kind of
>plugins shouldn't do anything and should not be listed in the report
>section).
>
>Is there a way to handle that as for now? (like an API for unregistering the
>report plugin so that it doesn't appear in the Reports menu) Or is it
>currently a limitation?
>Maybe I should not put the taglist plugin (and Javadoc and PMD) in the
>reporting section of the root project, but then I would have to do it in
>every module...
>
>Cheers,
>Fabrice.
>
>  
>

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