JDK-8272945: Use snippets in java.compiler documentation

[jonathan-gibbons]

Please review a patch to use snippets in the java.compiler documentation, instead of a mix of raw HTML and/or {@code ...}. The change is just about the presentation of the code fragments; there are no changes to the normative specifications for the module.

One of the examples went to extraordinary lengths to include the character sequence */ within the example. That example has been replaced by an external snippet in a separate source file, which does not have any restriction on the use of */. However, it does require that the file be excluded from standard compilation, and that is done by setting EXCLUDES, once for the "interim" compiler, and once again for the "product" compiler. Going forward, a better solution might be to modify the SetupJavaCompilation macro to ignore all directories whose name is not a valid Java identifier (or, if easier, contains a -, such as doc-files or snippet-files.)

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Issue

• JDK-8272945: Use snippets in java.compiler documentation

Reviewers

• Erik Joelsson (@erikj79 - Reviewer) ⚠️ Review applies to 27467bf
• Alan Bateman (@AlanBateman - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/6686/head:pull/6686
$ git checkout pull/6686

Update a local copy of the PR:
$ git checkout pull/6686
$ git pull https://git.openjdk.java.net/jdk pull/6686/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 6686

View PR using the GUI difftool:
$ git pr show -t 6686

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/6686.diff

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons The following labels will be automatically applied to this pull request:

• build
• compiler

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 02: Full - Incremental (0cbc3961)
• 01: Full - Incremental (27467bf2)
• 00: Full (97cedc9a)

[erikj79]

Build changes look ok.

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8272945: Use snippets in java.compiler documentation

Reviewed-by: erikj, alanb

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 165 new commits pushed to the master branch:

• 42d9b1b: 8277106: Cannot compile certain sources with --release
• ba86dd4: 8278445: ProblemList tools/jpackage/share/IconTest.java on macosx-x64
• 92aa75b: 8274903: Zero: Support AsyncGetCallTrace
• 8345453: 8272392: Lanai: SwingSet2. Black background on expanding tree node
• 9b74749: 8276660: Scalability bottleneck in java.security.Provider.getService()
• 2478158: 8277361: java/nio/channels/Channels/ReadXBytes.java fails with OOM error
• 8af3b27: 8277850: C2: optimize mask checks in counted loops
• 3e93e0b: 8276769: -Xshare:auto should tolerate problems in the CDS archive
• 79165b7: 8278324: Update the --generate-cds-archive jlink plugin usage message
• 40d726b: 8278310: Improve logging in CDS DynamicLoaderConstraintsTest.java
• ... and 155 more: https://git.openjdk.java.net/jdk/compare/98a9f037397d437d2c3221e8522ed8ab397a457a...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[jonathan-gibbons]

/integrate

[openjdk]

Going to push as commit fb11d8f.
Since your change was applied there have been 165 commits pushed to the master branch:

• 42d9b1b: 8277106: Cannot compile certain sources with --release
• ba86dd4: 8278445: ProblemList tools/jpackage/share/IconTest.java on macosx-x64
• 92aa75b: 8274903: Zero: Support AsyncGetCallTrace
• 8345453: 8272392: Lanai: SwingSet2. Black background on expanding tree node
• 9b74749: 8276660: Scalability bottleneck in java.security.Provider.getService()
• 2478158: 8277361: java/nio/channels/Channels/ReadXBytes.java fails with OOM error
• 8af3b27: 8277850: C2: optimize mask checks in counted loops
• 3e93e0b: 8276769: -Xshare:auto should tolerate problems in the CDS archive
• 79165b7: 8278324: Update the --generate-cds-archive jlink plugin usage message
• 40d726b: 8278310: Improve logging in CDS DynamicLoaderConstraintsTest.java
• ... and 155 more: https://git.openjdk.java.net/jdk/compare/98a9f037397d437d2c3221e8522ed8ab397a457a...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jonathan-gibbons Pushed as commit fb11d8f.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.