Incorrect and confusing site:stage goal documentation
-----------------------------------------------------
Key: MSITE-578
URL: http://jira.codehaus.org/browse/MSITE-578
Project: Maven 2.x and 3.x Site Plugin
Issue Type: Bug
Components: site:stage(-deploy)
Affects Versions: 2.2
Reporter: SebbASF
The site:stage goal contains the following doc:
generatedSiteDirectory:
Directory containing generated documentation.
* Type: java.io.File
* Required: Yes
* Expression: ${project.build.directory}/generated-site
The expression looks wrong.
The explanation is also a bit ambiguous - is the directory used to find already
generated documentation, or is it used as the output directory from site:stage?
In which case, how does it differ from outputDirectory ?
The page also contains:
outputDirectory:
Directory containing the generated project sites and report distributions.
* Type: java.io.File
* Required: Yes
* Expression: ${siteOutputDirectory}
* Default: ${project.reporting.outputDirectory}
Again, it's not obvious if this is an output or input directory.
Also, why is the parameter marked as "Required" when there is a default?
--
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
