Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4468396

stddoclet: give user more control over doc-file copying

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 1.4.0
    • 1.4.0
    • tools
    • beta2
    • generic
    • generic
    • Verified

      We just changed the standard doclet so that when it copies
      doc-files, it also copies all of its subdirectories
      (previously it did not copy any of its subdirectories).
      As stated below, this winds up copying the SCCS directory,
      which breaks the bringover.

      We could either hard-code it to not copy any directory named "SCCS",
      or provide an option to specify the name of the directory
      it should ignore.

      This is a bit nasty.

      - If we hard-code directory names, we would have to include
        all possible directory names used for source code control
        under all operating systems.

      - If we provide an option to exclude SCCS, that means that
        all scripts for javadoc that operate on code under source
        control are effectively broken, and all need to be changed.
        It also means that this option would always be required by
        any code under source code control, even if you don't use
        doc-files (which includes virtually all of the simple cases,
        and most of the rest)

      I propose we return to the original default behavior
      of not doing a deep copy of doc-files. Jamie, unless you
      have other alternatives, we should make this change ASAP.

      Then add an option for deep copy, that allows the exclusion
      of certain directory names. I suggest an option something
      like "copydocfiles" that takes "shallow" or "deep" as its
      argument, where "shallow" is the default.

        -copydocfiles shallow|deep

      As far as excluding the SCCS directory, it seems we should
      have a general mechanism for skipping SCCS directories,
      possibly using the existing -exclude option.
      If a general mechanism isn't needed, we could create a special
      case such as:

        -excludedocfilesdir SCCS

            jhosunw Jamie Ho (Inactive)
            jhosunw Jamie Ho (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: