8336036: Synthetic documentation for a record's equals is incorrect for floating-point types

[liach]

Fixes to Javadoc's default documentation on record classes, that all primitives are compared as if with their wrapper classes' compare method by default.

---

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-8336036: Synthetic documentation for a record's equals is incorrect for floating-point types (Bug - P3)

Reviewers

• Pavel Rappo (@pavelrappo - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 20129

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back liach! 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]

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

8336036: Synthetic documentation for a record's equals is incorrect for floating-point types

Reviewed-by: prappo

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 13 new commits pushed to the master branch:

• dea9274: 8332125: [nmt] Totals in diff report should print out total malloc and mmap diffs
• 5c612c2: 8332689: RISC-V: Use load instead of trampolines
• 6fcd49f: 8336239: Fix javadoc markup in java.lang.Process
• b32e4a6: 8335356: Shenandoah: Improve concurrent cleanup locking
• 62cbf70: 8336085: Fix simple -Wzero-as-null-pointer-constant warnings in CDS code
• 2928753: 8324966: Allow selecting jtreg test case by ID from make
• 1772a92: 8334457: Test javax/swing/JTabbedPane/bug4666224.java fail on macOS with because pressing the ‘C’ key does not switch the layout to WRAP_TAB_LAYOUT
• b7d0eff: 8207908: JMXStatusTest.java fails assertion intermittently
• cf940e1: 8335553: [Graal] Compiler thread calls into jdk.internal.vm.VMSupport.decodeAndThrowThrowable and crashes in OOM situation
• b363de8: 8335946: DTrace code snippets should be generated when DTrace flags are enabled
• ... and 3 more: https://git.openjdk.org/jdk/compare/66db71563c3ebd715a1192a9b399b618d7bdb8d0...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.

[openjdk]

@liach 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.

[mlbridge]

Webrevs

• 00: Full (ee6efdc9)

[cushon]

This looks good to me, FWIW. Thanks for the fix!

[pavelrappo]

Looks good.

[liach]

/integrate

[openjdk]

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

• 687601e: 8336257: Additional tests in jmxremote/startstop to match on PID not app name
• 8890557: 8335623: Clean up HtmlTag.HtmlTag and make the ARIA role attribute global
• 73e3e0e: 8321509: False positive in get_trampoline fast path causes crash
• 9eb611e: 8334055: Unhelpful 'required: reference' diagnostics after JDK-8043226
• 5100303: 8335668: NumberFormat integer only parsing should throw exception for edge case
• 58c9842: 8336021: Doccheck: valign not allowed for HTML5 in java.xml
• d06d79c: 8325369: @sealedGraph: Bad link to image for tag on nested classes
• dea9274: 8332125: [nmt] Totals in diff report should print out total malloc and mmap diffs
• 5c612c2: 8332689: RISC-V: Use load instead of trampolines
• 6fcd49f: 8336239: Fix javadoc markup in java.lang.Process
• ... and 10 more: https://git.openjdk.org/jdk/compare/66db71563c3ebd715a1192a9b399b618d7bdb8d0...master

Your commit was automatically rebased without conflicts.

[openjdk]

@liach Pushed as commit b3ef2a6.

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

[liach]

/backport :jdk23

[openjdk]

@liach the backport was successfully created on the branch backport-liach-b3ef2a60-jdk23 in my personal fork of openjdk/jdk. To create a pull request with this backport targeting openjdk/jdk:jdk23, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit b3ef2a60 from the openjdk/jdk repository.

The commit being backported was authored by Chen Liang on 11 Jul 2024 and was reviewed by Pavel Rappo.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk:

$ git fetch https://github.com/openjdk-bots/jdk.git backport-liach-b3ef2a60-jdk23:backport-liach-b3ef2a60-jdk23
$ git checkout backport-liach-b3ef2a60-jdk23
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk.git backport-liach-b3ef2a60-jdk23