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

Consider an alternative item separator for multi-item option values

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P4
    • 20
    • 20
    • tools
    • None

    Description

      Javadoc options, such as `noqualifier`, `exclude`, `tag`, etc., use `:` (colon) to separate items in their multi-item value. For example:

          -exclude java.net:java.lang:java.io

      Unix uses `:` to separate file paths. For example:

      ```
      -docletpath dir1:dir2\subdir2
      ```

      While the character is the same, the separators it represents are semantically different. The path separator changes with the platform, whereas the value separator does not. These superficial similarity of separators on Unix might trick users into thinking that they must change both when on another platform.

      We could define an alternative value separator that does not clash with the path separator on any of the supported platforms. For example, `,` (comma). We could also define the value separator once (in the man page and elsewhere) and refer to it in every affected option. We just have to make sure that an individual item cannot contain `,` for every multi-item option value.

      Attachments

        Issue Links

          Activity

            People

              jjg Jonathan Gibbons
              prappo Pavel Rappo
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: