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

Mark doclet.xml text file with "do not edit/private interface subject to change"

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P4
    • Resolution: Won't Fix
    • Affects Version/s: 5.0
    • Fix Version/s: 10
    • Component/s: tools

      Description

      Mark the top of any text configuration files with the following all caps text:

      DO NOT EDIT / PRIVATE INTERFACE SUBJECT TO CHANGE

      This should apply to all text files that end up in tools.jar
      that are not part of the public interface. The only file I can
      see it applies to is:

      src/share/classes/com/sun/tools/doclets/internal/toolkit/resources/doclet.xml

      This does not apply to doclets.properties or standard.properties, as these
      two files are part of the public interface.

      This is to comply with the Orion Compatibility Policy document which
      states that any text file, whether it's declared a "private interface" or not,
      will be found by customers and used. It's not just config files, but log files
      too. Therefore those types of files are considered by the document to be liable
      to compatibility control, unless the file has the above explicit text in it.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              bpatel Bhavesh Patel (Inactive)
              Reporter:
              dkramersunw Douglas Kramer (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: