[
https://issues.apache.org/jira/browse/MJAVADOC-451?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15387139#comment-15387139
]
Richard Sand commented on MJAVADOC-451:
---------------------------------------
Hi Robert - I've uploaded to the issue a zip file that contains a couple of
simple POMs, a single class file for testing with, and the maven log and a
snapshot of my file system showing what happens when the looping occurs.
Basically to trip this condition, the pom executes javadoc:fix and specifies
force=true and runs in the generate-sources phase. Its a bad combination
obviously.
But this particular circumstance is not the main reason to introduce a skip
option. Most plugins that alter the project in some way have a skip flag - in
fact most of the apache maven plugins have a skip option, and the Javadoc
plugin itself has a skip - its just this specific goal that lacks the skip.
In my projects, I use the goal with force=true but sometime it is useful to be
able to simply turn it off. I truly can't think of any downside to providing
this option. It is simple, it is useful, and it doesn't impact any other
functionality or regression.
> Add "skip" option to javadoc:fix goal
> -------------------------------------
>
> Key: MJAVADOC-451
> URL: https://issues.apache.org/jira/browse/MJAVADOC-451
> Project: Maven Javadoc Plugin
> Issue Type: Improvement
> Components: javadoc
> Affects Versions: 2.10.3
> Environment: all
> Reporter: Richard Sand
> Priority: Minor
> Attachments: maven-javadoc-plugin-MJAVADOC451.patch, skip.patch
>
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> I've a project where we want to use the javadoc:fix goal in a non-interactive
> (forced) mode. I know this isn't recommended usage but we have specific
> reasons for this particular project. It is useful to have a parameter to tell
> maven to skip this goal if desired.
> Also, since using the javadoc:fix with "force" as part of the build lifecycle
> will cause an endless loop as maven executes the clirr:check goal, adding
> this parameter allows javadoc:fix to invoke clirr:check without looping.
> Many other goals/plugins have a skip parameter, so I added one called
> "maven.javadoc.fix.skip".
> I've provided a patch here to add this parameter. Its a trivial enough patch
> that I hope you'll allow it for 2.10.4. Thanks!
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
