Skip to content

Conversation

@hns
Copy link
Member

@hns hns commented Nov 17, 2025

Please review a change to ignore leading and trailing line breaks when comparing inline and external snippet contents in a hybrid snippets. It is often hard to get leading/trailing linebreaks identical between the two, and it is generally not a significant aspect in terms of consistency.

There is an open CSR for this issue to update the section about hybrid snippets in the doc comment spec.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change requires CSR request JDK-8371908 to be approved
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issues

  • JDK-8304408: Javadoc unexpectedly reports that hybrid snippet contents mismatch (Bug - P4)
  • JDK-8371908: Javadoc unexpectedly reports that hybrid snippet contents mismatch (CSR)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28357

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@hns
Copy link
Member Author

hns commented Nov 17, 2025

/csr needed

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 17, 2025

👋 Welcome back hannesw! 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
Copy link

openjdk bot commented Nov 17, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Nov 17, 2025
@openjdk
Copy link

openjdk bot commented Nov 17, 2025

@hns an approved CSR request is already required for this pull request.

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.org label Nov 17, 2025
@openjdk
Copy link

openjdk bot commented Nov 17, 2025

@hns The following label will be automatically applied to this pull request:

  • javadoc

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 rfr Pull request is ready for review label Nov 17, 2025
@mlbridge
Copy link

mlbridge bot commented Nov 17, 2025

Webrevs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

csr Pull request needs approved CSR before integration javadoc javadoc-dev@openjdk.org rfr Pull request is ready for review

Development

Successfully merging this pull request may close these issues.

2 participants