Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JDK-8296188: Update style and header in JDWP Protocol spec and JVMTI spec #10957

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Nov 2, 2022

Please review a simple makefile-only update to inject the standard stylesheet and navigation header into the two JDK specifications that are generated as HTML files in the gensrc directory, to bring these docs in line with the rest of the specs documents.

Generated docs at:

The JVM TI spec has a list of links at the beginning, in bold. This is not a CSS issue ... it is in the HTML, generated by XSL scripts. Ideally, the list should be in a separate <nav> element and the <b> tags removed, and maybe the style revised using local CSS. But that is a separate issue.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8296188: Update style and header in JDWP Protocol spec and JVMTI spec

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/10957/head:pull/10957
$ git checkout pull/10957

Update a local copy of the PR:
$ git checkout pull/10957
$ git pull https://git.openjdk.org/jdk pull/10957/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10957

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/10957.diff

Update style and header in JDWP Protocol spec and JVMTI spec
@bridgekeeper
Copy link

bridgekeeper bot commented Nov 2, 2022

👋 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 openjdk bot added the rfr Pull request is ready for review label Nov 2, 2022
@openjdk
Copy link

openjdk bot commented Nov 2, 2022

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

  • build

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

@openjdk openjdk bot added the build build-dev@openjdk.org label Nov 2, 2022
@mlbridge
Copy link

mlbridge bot commented Nov 2, 2022

Webrevs

@openjdk
Copy link

openjdk bot commented Nov 2, 2022

@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:

8296188: Update style and header in JDWP Protocol spec and JVMTI spec

Reviewed-by: erikj

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 2, 2022
@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Nov 2, 2022

Going to push as commit fd60036.
Since your change was applied there has been 1 commit pushed to the master branch:

  • c7b95a8: 8296163: [aarch64] Cleanup Pre/Post addressing mode classes

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 2, 2022
@openjdk openjdk bot closed this Nov 2, 2022
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 2, 2022
@openjdk
Copy link

openjdk bot commented Nov 2, 2022

@jonathan-gibbons Pushed as commit fd60036.

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

@jonathan-gibbons jonathan-gibbons deleted the 8296188.docs-style-headers branch November 2, 2022 22:59
Copy link
Contributor

@sspitsyn sspitsyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.
Thank you for the spec improvements!
Serguei

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build build-dev@openjdk.org integrated Pull request has been integrated
3 participants