Please review a change to solve a number of issues in the HTML presentation of 
the JVM Tool Interface specification that prevented it from using JDK-level 
documentation features such as CSS themes and heading permalinks:

 - Use wrapped `<section>` elements instead of empty `<p>` elements  for 
section ids
 - Use the CSS `light-dark()` function for colors in inline styles to support 
the dark theme
 - Resolve a number of unwanted interactions of the inline styles with the 
`jsk-default.css` stylesheet
 - Remove the need for hard-coded `<div class="sep"/>` separators by defining 
proper margins
 - Move `<hr>` tags between sections and don't use them for section `id` 
attributes
 - Solve minor whitespace issues by setting `indent="no"` on `<xsl:output>`

The rendered `jvmti.html` file as processed by the JDK build script [can be 
viewed here](https://cr.openjdk.org/~hannesw/8393263/docs.00/specs/jvmti.html). 
It now supports light and dark themes, hovering over headings shows a permalink 
icon, and various rendering problems resulting from interaction with 
`jdk-default.css` (especially in function/callback tables) have been fixed. The 
spec is also easier to read on very wide and very small displays.

The unprocessed version of the spec as generated by the XSL stylesheet [is also 
available](https://cr.openjdk.org/~hannesw/8393263/raw.00/jvmti.html). It 
should be visually unchanged from the old version.

---------
- [x] I confirm that I make this contribution in accordance with the [OpenJDK 
Interim AI Policy](https://openjdk.org/legal/ai).

-------------

Depends on: https://git.openjdk.org/jdk/pull/33127

Commit messages:
 - 8393263: JVM Tool Interface spec presentation needs work

Changes: https://git.openjdk.org/jdk/pull/33181/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=33181&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8393263
  Stats: 244 lines in 2 files changed: 61 ins; 70 del; 113 mod
  Patch: https://git.openjdk.org/jdk/pull/33181.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/33181/head:pull/33181

PR: https://git.openjdk.org/jdk/pull/33181

Reply via email to