You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "SebbASF (JIRA)" <ji...@codehaus.org> on 2011/04/07 14:04:25 UTC
[jira] Commented: (MSITE-578) Incorrect and confusing documentation
of site directories
[ http://jira.codehaus.org/browse/MSITE-578?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=262794#action_262794 ]
SebbASF commented on MSITE-578:
-------------------------------
The fixed descriptions are much clearer, thanks.
However, generatedSiteDirectory and outputDirectory are still marked as "required", even though they have defaults.
> Incorrect and confusing documentation of site directories
> ---------------------------------------------------------
>
> 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, 3.0-beta-3
> Reporter: SebbASF
> Assignee: Lukas Theussl
> Fix For: 2.3, 3.0-beta-4
>
>
> 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