JDK-8302360 Atomic*.compareAndExchange Javadoc unclear

[viktorklang-ora]

I think the following proposal is very non-invasive and merely draws attention to the fact that "witness value" is a specific term related to the notion of these atomic methods.

It's a small change which I think provides additional clarity, see JBS for the discussion on the topic.

---

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-8302360: Atomic*.compareAndExchange Javadoc unclear

Reviewers

• Martin Buchholz (@Martin-Buchholz - Reviewer) ⚠️ Review applies to 923d23d0
• David Holmes (@dholmes-ora - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12880

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

Using diff file

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

[bridgekeeper]

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

@viktorklang-ora The following label will be automatically applied to this pull request:

• core-libs

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

• 01: Full - Incremental (d6d2e81b)
• 00: Full (923d23d0)

[openjdk]

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

8302360: Atomic*.compareAndExchange Javadoc unclear

Reviewed-by: martin, dholmes

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

• 34a9246: 8274264: Not all of G1 young collection verification honors the verification type
• a7e308a: 8303576: addIdentitiesToKeystore in KeystoreImpl.m needs CFRelease call in early potential CHECK_NULL return
• dd79410: 8303509: Socket setTrafficClass does not work for IPv4 connections when IPv6 enabled
• dc523a5: 8300258: C2: vectorization fails on simple ByteBuffer loop
• 5e232cf: 8303564: C2: "Bad graph detected in build_loop_late" after a CMove is wrongly split thru phi
• 8cfd74f: 8302976: C2 intrinsification of Float.floatToFloat16 and Float.float16ToFloat yields different result than the interpreter
• 02875e7: 8171156: Class java.util.LocaleISOData has outdated information for country Code NP
• ad326fc: 8299570: [JVMCI] Insufficient error handling when CodeBuffer is exhausted
• 05ceb37: 8303833: java.util.LocaleISOData has wrong comments for 'Norwegian Bokmål' and 'Volapük'
• 25de222: 8303839: [BACKOUT] JDK-8302799 and JDK-8302189
• ... and 154 more: https://git.openjdk.org/jdk/compare/83d77b1cbb6d0179e9c130d51b7fada2e76e86d3...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@Martin-Buchholz, @dholmes-ora) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[dholmes-ora]

This change is not appropriate as discussed in JBS. And unclear why you changed only this version? Leftover?

[viktorklang-ora]

@dholmes-ora Good catch, will fix.

[dholmes-ora]

Looks fine now. Thanks.

[viktorklang-ora]

/integrate

[openjdk]

@viktorklang-ora
Your change (at version d6d2e81) is now ready to be sponsored by a Committer.

[viktorklang-ora]

/sponsor @AlanBateman

[openjdk]

@viktorklang-ora Only Committers are allowed to sponsor changes.

[viktorklang-ora]

@AlanBateman Who would be willing to sponsor this? 🤔

[Martin-Buchholz]

/sponsor

[openjdk]

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

• 8b740b4: 8302779: HelidonAppTest.java fails with "assert(_cb == CodeCache::find_blob(pc())) failed: Must be the same" or SIGSEGV
• 562c8fc: 8303691: Fedora based devkit build should load more packages from archive location
• e930b63: 8303924: ProblemList serviceability/sa/UniqueVtableTest.java on Linux
• af0ca78: 8303609: ProblemList serviceability/sa/TestSysProps.java with ZGC
• 8b0eb72: 8289765: JDI EventSet/resume/resume008 failed with "ERROR: suspendCounts don't match for : VirtualThread-unparker"
• 5726d31: 8301074: Replace NULL with nullptr in share/opto/
• a9dba56: 8300783: Consolidate byteswap implementations
• 769e740: 8303915: javadoc build failure after JDK-8294959
• f9aadb9: 8303489: Add a test to verify classes in vmStruct have unique vtables
• 595645c: 8294959: java.base java.lang.Module uses ASM to load module-info.class
• ... and 171 more: https://git.openjdk.org/jdk/compare/83d77b1cbb6d0179e9c130d51b7fada2e76e86d3...master

Your commit was automatically rebased without conflicts.

[openjdk]

@Martin-Buchholz @viktorklang-ora Pushed as commit d06308c.

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