Issue Details (XML | Word | Printable)

Key: MPXDOC-146
Type: Improvement Improvement
Status: Open Open
Priority: Major Major
Assignee: Unassigned
Reporter: Jamie Bisotti
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Maven 1.x XDoc Plugin

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

Created: 17/Jun/05 10:42 AM   Updated: 22/Aug/05 07:33 AM
Return to search
Component/s: None
Affects Version/s: 1.9
Fix Version/s: None

Time Tracking:
Not Specified


 Description  « Hide

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.



Arnaud Heritier added a comment - 17/Jun/05 11:36 AM

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


Jamie Bisotti added a comment - 22/Aug/05 07:33 AM

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.