You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Jamie Bisotti (JIRA)" <ji...@codehaus.org> on 2005/06/17 17:42:58 UTC

[jira] Created: (MPXDOC-146) Allow additional 'maven.docs.src' directories to be specified

Allow additional 'maven.docs.src' directories to be specified
-------------------------------------------------------------

         Key: MPXDOC-146
         URL: http://jira.codehaus.org/browse/MPXDOC-146
     Project: maven-xdoc-plugin
        Type: Improvement
    Versions: 1.9    
    Reporter: Jamie Bisotti
 Assigned to: Arnaud HERITIER 


Assume a directory structure like the following:

common/
   xdoc/
      foo/
   project.xml
   project.properties
project1/
   ...
   xdoc/
   project.xml
   project.properties
project2/
   ...
   xdoc/
   project.xml
   project.properties

where "projectN" extends "common".  The "common/xdoc/foo" documentation applies to all "projectN"; I don't want to duplicate it, so it lives in "common".  However, in order to get it included in the site for "projectN", I have to have a preGoal on xdoc:copy-user-resources to copy it to "projectN/xdoc/foo".  This results in a needless copy and it causes problems with SVN marking these copied files as needing to be added to the repository.

I'd like to see one of two enhancements (or both):
   1. Add a property ('maven.docs.src.additional', or whatever), which would specify a list of additional directories that would be included in the xdoc transformation; this would prevent the copy and the SVN confusion.
   2. By default, if a project extends another project, look for, and include, the xdoc of the extended project in the extending projects xdoc transformation.

-- 
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, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPXDOC-146) Allow additional 'maven.docs.src' directories to be specified

Posted by "Jamie Bisotti (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPXDOC-146?page=comments#action_44913 ] 

Jamie Bisotti commented on MPXDOC-146:
--------------------------------------

Yes, you are correct, copying into ${maven.gen.docs} does get around the SVN annoyance.  However, I think the request (#1 or #2) is still valid.  I a project "extends" another project, I believe it should "extend" the entire thing, not just bits and pieces.

> Allow additional 'maven.docs.src' directories to be specified
> -------------------------------------------------------------
>
>          Key: MPXDOC-146
>          URL: http://jira.codehaus.org/browse/MPXDOC-146
>      Project: maven-xdoc-plugin
>         Type: Improvement
>     Versions: 1.9
>     Reporter: Jamie Bisotti

>
>
> Assume a directory structure like the following:
> common/
>    xdoc/
>       foo/
>    project.xml
>    project.properties
> project1/
>    ...
>    xdoc/
>    project.xml
>    project.properties
> project2/
>    ...
>    xdoc/
>    project.xml
>    project.properties
> where "projectN" extends "common".  The "common/xdoc/foo" documentation applies to all "projectN"; I don't want to duplicate it, so it lives in "common".  However, in order to get it included in the site for "projectN", I have to have a preGoal on xdoc:copy-user-resources to copy it to "projectN/xdoc/foo".  This results in a needless copy and it causes problems with SVN marking these copied files as needing to be added to the repository.
> I'd like to see one of two enhancements (or both):
>    1. Add a property ('maven.docs.src.additional', or whatever), which would specify a list of additional directories that would be included in the xdoc transformation; this would prevent the copy and the SVN confusion.
>    2. By default, if a project extends another project, look for, and include, the xdoc of the extended project in the extending projects xdoc transformation.

-- 
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, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MPXDOC-146) Allow additional 'maven.docs.src' directories to be specified

Posted by "Arnaud Heritier (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MPXDOC-146?page=all ]

Arnaud Heritier updated MPXDOC-146:
-----------------------------------

    Assign To:     (was: Arnaud Heritier)

> Allow additional 'maven.docs.src' directories to be specified
> -------------------------------------------------------------
>
>          Key: MPXDOC-146
>          URL: http://jira.codehaus.org/browse/MPXDOC-146
>      Project: maven-xdoc-plugin
>         Type: Improvement
>     Versions: 1.9
>     Reporter: Jamie Bisotti

>
>
> Assume a directory structure like the following:
> common/
>    xdoc/
>       foo/
>    project.xml
>    project.properties
> project1/
>    ...
>    xdoc/
>    project.xml
>    project.properties
> project2/
>    ...
>    xdoc/
>    project.xml
>    project.properties
> where "projectN" extends "common".  The "common/xdoc/foo" documentation applies to all "projectN"; I don't want to duplicate it, so it lives in "common".  However, in order to get it included in the site for "projectN", I have to have a preGoal on xdoc:copy-user-resources to copy it to "projectN/xdoc/foo".  This results in a needless copy and it causes problems with SVN marking these copied files as needing to be added to the repository.
> I'd like to see one of two enhancements (or both):
>    1. Add a property ('maven.docs.src.additional', or whatever), which would specify a list of additional directories that would be included in the xdoc transformation; this would prevent the copy and the SVN confusion.
>    2. By default, if a project extends another project, look for, and include, the xdoc of the extended project in the extending projects xdoc transformation.

-- 
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, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPXDOC-146) Allow additional 'maven.docs.src' directories to be specified

Posted by "Arnaud HERITIER (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPXDOC-146?page=comments#action_41507 ] 

Arnaud HERITIER commented on MPXDOC-146:
----------------------------------------

Can't you copy you data in ${maven.gen.docs} which isn't stored in SVN ?

> Allow additional 'maven.docs.src' directories to be specified
> -------------------------------------------------------------
>
>          Key: MPXDOC-146
>          URL: http://jira.codehaus.org/browse/MPXDOC-146
>      Project: maven-xdoc-plugin
>         Type: Improvement
>     Versions: 1.9
>     Reporter: Jamie Bisotti
>     Assignee: Arnaud HERITIER

>
>
> Assume a directory structure like the following:
> common/
>    xdoc/
>       foo/
>    project.xml
>    project.properties
> project1/
>    ...
>    xdoc/
>    project.xml
>    project.properties
> project2/
>    ...
>    xdoc/
>    project.xml
>    project.properties
> where "projectN" extends "common".  The "common/xdoc/foo" documentation applies to all "projectN"; I don't want to duplicate it, so it lives in "common".  However, in order to get it included in the site for "projectN", I have to have a preGoal on xdoc:copy-user-resources to copy it to "projectN/xdoc/foo".  This results in a needless copy and it causes problems with SVN marking these copied files as needing to be added to the repository.
> I'd like to see one of two enhancements (or both):
>    1. Add a property ('maven.docs.src.additional', or whatever), which would specify a list of additional directories that would be included in the xdoc transformation; this would prevent the copy and the SVN confusion.
>    2. By default, if a project extends another project, look for, and include, the xdoc of the extended project in the extending projects xdoc transformation.

-- 
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, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org