8309853: StructuredTaskScope.join description improvements

[AlanBateman]

StructuredTaskScope's class description introduces the join method as waiting for all subtasks to finish but the API docs for join/joinUntil are phrased in terms of waiting for all threads to finish. ShutdownOnXXX join/joinUntil inherit this description but would be clearer if their description said they wait until all subtasks finished or a subtask to succeed or fail.

---

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
• Change requires CSR request JDK-8309933 to be approved

Issues

• JDK-8309853: StructuredTaskScope.join description improvements (Bug - P3)
• JDK-8309933: StructuredTaskScope.join description improvements (CSR)

Reviewers

• Ron Pressler (@pron - Committer)
• Joe Darcy (@jddarcy - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14419

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

Using diff file

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

Webrev

Link to Webrev Comment

[AlanBateman]

/csr

[bridgekeeper]

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

@AlanBateman has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@AlanBateman please create a CSR request for issue JDK-8309853 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

[openjdk]

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

• 00: Full (5b326181)

[openjdk]

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

8309853: StructuredTaskScope.join description improvements

Reviewed-by: rpressler, darcy

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

• 59c6c0e: 8310335: JFR: Modernize collections and switch statements
• 826dcb5: 8264899: C1: -XX:AbortVMOnException does not work if all methods in the call stack are compiled with C1 and there are no exception handlers
• 658c337: 8309296: jdk/jfr/event/runtime/TestAgentEvent.java fails due to "missing" dynamic JavaAgent
• 70e1c92: 8310297: assert(static_cast(result) == thing) with ctw
• 574c6f0: 8310376: Extend SetupTarget macro with DIR parameter
• 7ea22cd: 8310369: UTIL_ARG_WITH fails when arg is disabled
• 01623f6: 8310133: Effectivelly final condition not enforced in guards for binding variables from the same case
• a15db1a: 8302865: Illegal bytecode for break from if with instanceof pattern matching condition
• 67fbd87: 8310143: RandomCommandsTest fails due to unexpected VM exit code after JDK-8282797
• 9eed049: 8310321: make JDKOPT_CHECK_CODESIGN_PARAMS more verbose
• ... and 110 more: https://git.openjdk.org/jdk/compare/57fc9a3e968cafe3b618a216630e703a39d5676e...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.

[AlanBateman]

/integrate

[openjdk]

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

• ac44ef1: 8310586: ProblemList java/lang/ScopedValue/StressStackOverflow.java#default with virtual threads on linux-all
• 3be50da: 8310512: Cleanup indentation in jfc files
• f286e5a: 8310575: no @since for StandardDoclet
• 16a34e8: 8310384: Add hooks for custom image creation
• 226c6a0: 8309883: no @since info in com.sun.tools.javac package-info.java, Main.java
• fd1163d: 8310332: Fix -Wconversion warnings in MethodData
• 72501cf: 8310379: Relax prerequisites for java.base-jmod target
• 59c6c0e: 8310335: JFR: Modernize collections and switch statements
• 826dcb5: 8264899: C1: -XX:AbortVMOnException does not work if all methods in the call stack are compiled with C1 and there are no exception handlers
• 658c337: 8309296: jdk/jfr/event/runtime/TestAgentEvent.java fails due to "missing" dynamic JavaAgent
• ... and 117 more: https://git.openjdk.org/jdk/compare/57fc9a3e968cafe3b618a216630e703a39d5676e...master

Your commit was automatically rebased without conflicts.

[openjdk]

@AlanBateman Pushed as commit 3661cde.

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

[AlanBateman]

/backport jdk21

[openjdk]

@AlanBateman the backport was successfully created on the branch AlanBateman-backport-3661cdee in my personal fork of openjdk/jdk21. To create a pull request with this backport targeting openjdk/jdk21:master, 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 3661cdee from the openjdk/jdk repository.

The commit being backported was authored by Alan Bateman on 22 Jun 2023 and was reviewed by Ron Pressler and Joe Darcy.

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/jdk21:

$ git fetch https://github.com/openjdk-bots/jdk21.git AlanBateman-backport-3661cdee:AlanBateman-backport-3661cdee
$ git checkout AlanBateman-backport-3661cdee
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk21.git AlanBateman-backport-3661cdee