Uploaded image for project: 'HCatalog'
  1. HCatalog
  2. HCATALOG-184

Optionally do not generate forrest docs

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 0.3
    • None
    • None

    Description

      Currently ant package requires generating Forrest docs, which in general is a good thing. However, this is problematic on private networks for two reasons:

      1. Forrest may not be available on build machines. This can be worked around by checking in a forrest release (either the extracted sources, or extract the release on demand) as part of your build process. However, docs are not strictly required and in practice no one will look at the docs on a production machine.
      2. Forrest expects a public internet connection. Forrest attempts to update its plugins from a public internet location, which causes the HCatalog build to fail.

      For these reasons, I propose adding a -Dnoforrest ant property that disables building the forrest documentation. By default, it still builds the docs so most users will not notice. However, users attempting to build on a private network will not have to patch around doc generation.

      Attachments

        1. HCATALOG-184.diff
          3 kB
          Travis Crawford
        2. HCATALOG-184.diff
          2 kB
          Travis Crawford

        Activity

          People

            traviscrawford Travis Crawford
            traviscrawford Travis Crawford
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: