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

Support building of filtered spec bundles

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 14
    • Component/s: infrastructure
    • Labels:
      None
    • Subcomponent:
    • Resolved In Build:
      b03

      Description

      When new language & JVM features are developed, changes to the JLS and JVMS are described in "spec change documents". These are HTML pages built from Markdown sources.

      Spec change documents have dependencies on CSS files, a copyright page, and possibly other spec change documents. During development, a "spec bundle" consisting of all necessary files, formatted as a directory or zip archive, needs to be easily buildable and shareable.

      The 'make docs-jdk-specs' command is able to locate and process any spec change documents appearing in the sources (placing output in 'build/*/images/docs'). However, it builds all other specification documents as well. To produce a minimal spec bundle, we'd like the following enhancements:

      - A 'SPEC_FILTER' make variable that limits processing of spec files to those with names or folder names that match the filter. (The default, '%', matches everything.)

      - A 'docs-specs-zip' make target that is equivalent to 'docs-jdk-specs' followed by zipping up the result. (Compare 'docs-zip', which also runs javadoc.)

      - For clarity, placing a draft banner at the top of all spec files, just like javadoc output ("This specification is not final and is subject to change. Use is subject to license terms"), and support replacement of @@VERSION_STRING@@ during processing.

        Attachments

          Activity

            People

            Assignee:
            dlsmith Dan Smith
            Reporter:
            dlsmith Dan Smith
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: