[
http://jira.codehaus.org/browse/MTAGLIST-29?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_121097
]
Nate Stoddard commented on MTAGLIST-29:
---------------------------------------
I think this patch is a great idea, and it has helped educate me on how the
outputDirectory configuration acts behind the scenes.
I would assume that most plugins have the same outcome with the use of
outputDirectory, so how do users know that this is the normal operation of the
outputDirectory configuration? Would each plugin need this same patch for its
outputDirectory documentation?
Are any of this options possible?
- The "outputDirectory" member variable and plugin documentation is moved to
AbstractMavenReport; consequently inherited by each plugin? Then the
documentation would be the same for all plugins automatically. Since
getOutputDirectory() is abstract in AbstractMavenReport, I assume there might
already be a reason not to do this.
- During the site phase, create a log (warning or info) that the
outputDirectory parameter is being ignored.
> Fix handling of output directory
> --------------------------------
>
> Key: MTAGLIST-29
> URL: http://jira.codehaus.org/browse/MTAGLIST-29
> Project: Maven 2.x Taglist Plugin
> Issue Type: Bug
> Affects Versions: 2.1
> Reporter: Benjamin Bentmann
> Attachments: directory-handling.patch
>
>
> As for the outpuDirectory parameter:
> - its type should be File instead of String (see also [Common
> Bugs|http://www.nabble.com/Common-Bugs-to14783703s177.html])
> - it should NEVER be queried by the mojo. It may be used by the user to
> specify the output path if the mojo is run standalone but during a site
> build, the site plugin sets the output directory via
> MavenReport.setReportOutputDirectory(). For this reason,
> MavenReport.getReportOutputDirectory() should be called to access the
> EFFECTIVE output directory. AbstractMavenReport will return the original
> outputDirectory parameter value (by calling getOutputDirectory()) if the mojo
> is called standalone.
> - the expression "${project.reporting.outputDirectory}" should be used
> instead of the hard-coded "${project.build.directory}/site"
> - there is no need to create the output directory in the mojo, it's done when
> setting up the Sink for the report
--
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
---------------------------------------------------------------------
To unsubscribe from this list please visit:
http://xircles.codehaus.org/manage_email
