Maven 1.x XDoc Plugin
  1. Maven 1.x XDoc Plugin
  2. MPXDOC-146

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

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: 1.9
    • Fix Version/s: None
    • Labels:
      None
    • Number of attachments :
      0

      Description

      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.

        Activity

        Hide
        Arnaud Heritier added a comment -

        Can't you copy you data in $

        {maven.gen.docs}

        which isn't stored in SVN ?

        Show
        Arnaud Heritier added a comment - Can't you copy you data in $ {maven.gen.docs} which isn't stored in SVN ?
        Hide
        Jamie Bisotti added a comment -

        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.

        Show
        Jamie Bisotti added a comment - 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.
        Hide
        Michael Osipov added a comment -

        Please refer to https://cwiki.apache.org/confluence/display/MAVEN/The+Great+JIRA+Cleanup+of+2014 if you're wondering why this issue was closed out.

        Show
        Michael Osipov added a comment - Please refer to https://cwiki.apache.org/confluence/display/MAVEN/The+Great+JIRA+Cleanup+of+2014 if you're wondering why this issue was closed out.

          People

          • Assignee:
            Unassigned
            Reporter:
            Jamie Bisotti
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: