maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Benjamin Bentmann (JIRA)" <j...@codehaus.org>
Subject [jira] Commented: (MNG-3344) Provide new POM element to configure site directory (e.g. "src/site")
Date Sun, 10 Feb 2008 22:48:29 GMT

    [ http://jira.codehaus.org/browse/MNG-3344?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_123220
] 

Benjamin Bentmann commented on MNG-3344:
----------------------------------------

Another reason why such a POM element would be good: If we wanted to implement a rule [RequireSkinVersion|http://www.nabble.com/Plugin-Versions-in-the-Super-pom-to15367074s177.html#a15402554]
for the Maven Enforcer Plugin, this plugin could more easily share the config with the Maven
Site Plugin (needed to find the site descriptor).

> Provide new POM element to configure site directory (e.g. "src/site")
> ---------------------------------------------------------------------
>
>                 Key: MNG-3344
>                 URL: http://jira.codehaus.org/browse/MNG-3344
>             Project: Maven 2
>          Issue Type: New Feature
>          Components: POM
>    Affects Versions: 2.0.8
>            Reporter: Benjamin Bentmann
>             Fix For: 2.1-alpha-1
>
>
> As requested in MSITE-91 and its various duplicates, the input location for the site
generation should be configurable. Currently, this is realized by a configuration parameter
(siteDirectory) for the maven-site-plugin itself but I argue that this is not sufficient/robust
for all cases. The problem is that the plugin cannot access its configuration in ancestor
POMs and hence can only guess.
> For example, take the following multi-module scenario:
>   project-parent/
>     doc/
>       site.xml
>     project-module/
>       src/
>         site/
>           site.xml
> Let us ignore the fact that such is layout is unusual, weird, bad-practice or whatever
you would like to call it. The point is, it should be possible. The important aspect of the
example is that both POMs will need to use a different configuration of the maven-site-plugin
to find the site descriptor (and related files). The parent POM will have siteDirectory=doc
while the module POM will have siteDirectory=src/site.
> Now consider the plugin's steps when building the site for project-module. From the plugin
configuration in "project-module/pom.xml", it knows to search the site descriptor for the
sub project in "src/site". To apply inheritance, the plugin then needs to locate the site
descriptor of the parent project. Ups. The plugin cannot access the corresponding plugin configuration
in "project-parent/pom.xml". So it can only assume that the parent uses the same directory
layout for the site as the current sub module.
> Having a dedicated POM element for the site files, e.g. ${project.reporting.siteDirectory},
would allow the maven-site-plugin to properly determine the location of the site descriptor
of any ancestor project. The super POM can default this element to "src/site" to get the usual
behavior.

-- 
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

        

Mime
View raw message