Hadoop Common
  1. Hadoop Common
  2. HADOOP-5682

ant clean does not clean the generated api docs

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: build
    • Labels:
    1. hadoop-5682.patch
      0.5 kB
      Giridharan Kesavan

      Activity

      Hide
      Doug Cutting added a comment -

      So maybe we should change the api-xml and api-report tasks to read/write the current version of the jdiff xml from somewhere in build/jdiff, then add a new target that copies this to lib/jdiff. Then http://wiki.apache.org/hadoop/HowToRelease should be updated to reference this new target.

      While we're at it, we might rename these targets, perhaps as follows:

      • api-xml -> jdiff-xml (generates xml in build/)
      • api-report -> jdiff-report (uses xml in build/ & lib/ to generate html in build/)
      • jdiff-save (new task, copies xml in build/ to lib/, calls 'svn add' too?)

      Does this make sense?

      Show
      Doug Cutting added a comment - So maybe we should change the api-xml and api-report tasks to read/write the current version of the jdiff xml from somewhere in build/jdiff, then add a new target that copies this to lib/jdiff. Then http://wiki.apache.org/hadoop/HowToRelease should be updated to reference this new target. While we're at it, we might rename these targets, perhaps as follows: api-xml -> jdiff-xml (generates xml in build/) api-report -> jdiff-report (uses xml in build/ & lib/ to generate html in build/) jdiff-save (new task, copies xml in build/ to lib/, calls 'svn add' too?) Does this make sense?
      Hide
      Giridharan Kesavan added a comment -

      this jdiff file is generated whenever we call the package target.

      Show
      Giridharan Kesavan added a comment - this jdiff file is generated whenever we call the package target.
      Hide
      Doug Cutting added a comment -

      > I think we commit this file towards the release [ ... ]

      Then we probably shouldn't have 'ant clean' remove it. It's not generated except by someone building a release, is it?

      Show
      Doug Cutting added a comment - > I think we commit this file towards the release [ ... ] Then we probably shouldn't have 'ant clean' remove it. It's not generated except by someone building a release, is it?
      Hide
      Giridharan Kesavan added a comment -

      I think we commit this file towards the release, as a stable api doc for jdiff to compare with the latest trunk api docs.

      Show
      Giridharan Kesavan added a comment - I think we commit this file towards the release, as a stable api doc for jdiff to compare with the latest trunk api docs.
      Hide
      Doug Cutting added a comment -

      Sometimes we commit that file, no?

      Show
      Doug Cutting added a comment - Sometimes we commit that file, no?
      Hide
      Giridharan Kesavan added a comment -

      this patch cleans the generated api docs
      tnx!

      Show
      Giridharan Kesavan added a comment - this patch cleans the generated api docs tnx!

        People

        • Assignee:
          Giridharan Kesavan
          Reporter:
          Giridharan Kesavan
        • Votes:
          0 Vote for this issue
          Watchers:
          2 Start watching this issue

          Dates

          • Created:
            Updated:

            Development