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

8319948: jcmd man page needs to be updated #17213

Closed
wants to merge 4 commits into from

Conversation

dholmes-ora
Copy link
Member

@dholmes-ora dholmes-ora commented Jan 2, 2024

Please review these missing updates to the jcmd manpage - see JBS issue for details.

I also fixed the sub-command ordering in a few places and a couple of minor formatting fixes.

Thanks to @tstuefe for collating the initial information on what was missing. I used to jcmd help <cmd> option to compare the help text with the manpage text and adjusted the manpage accordingly (and found a few more omissions - some of which will be fixed by follow up RFE by the respective owners).


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-8319948: jcmd man page needs to be updated (Bug - P4)

Reviewers

Contributors

  • Thomas Stuefe <stuefe@openjdk.org>

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17213

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 2, 2024

👋 Welcome back dholmes! 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 Jan 2, 2024
@openjdk
Copy link

openjdk bot commented Jan 2, 2024

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

  • serviceability

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 serviceability serviceability-dev@openjdk.org label Jan 2, 2024
@mlbridge
Copy link

mlbridge bot commented Jan 2, 2024

Webrevs

@dholmes-ora
Copy link
Member Author

/label add hotspot
/contributor add @tstuefe

@openjdk openjdk bot added the hotspot hotspot-dev@openjdk.org label Jan 2, 2024
@openjdk
Copy link

openjdk bot commented Jan 2, 2024

@dholmes-ora
The hotspot label was successfully added.

@openjdk
Copy link

openjdk bot commented Jan 2, 2024

@dholmes-ora
Contributor Thomas Stuefe <stuefe@openjdk.org> successfully added.

Copy link
Contributor

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

Trivially can note that here in jcmd.1 VM.flags says "Prints the VM flag..." while diagnosticCommand.hpp says: "Print VM flag...".
We could make it consistent, but not important.
"Print" maybe in the minority compared to "Prints", but we have some of each. 8-)

@dholmes-ora
Copy link
Member Author

Thanks for the review @kevinjwalls . I did a consistency sweep over the VM subcommands and changed a lot of Prints to Print so the manpage matches the help text. Which form is better grammatically I'm not sure, but if we want to change things we should do that for the help text and manpage at the same time.

@openjdk
Copy link

openjdk bot commented Jan 3, 2024

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

8319948: jcmd man page needs to be updated

Co-authored-by: Thomas Stuefe <stuefe@openjdk.org>
Reviewed-by: kevinw, alanb

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

  • ba426d6: 8322841: Parallel: Remove unused using-declaration in MutableNUMASpace
  • 18cdc90: 8322801: RISC-V: The riscv path of the debian sysroot had been changed
  • fcf8368: 8322248: Fix inconsistent wording in ElementFilter.typesIn
  • a678416: 8322805: Eliminate -Wparentheses warnings in x86 code
  • 122bc77: 8322758: Eliminate -Wparentheses warnings in C2 code
  • e9e694f: 8320275: assert(_chunk->bitmap().at(index)) failed: Bit not set at index
  • da1091e: 8322807: Eliminate -Wparentheses warnings in gc code
  • c2477a5: 8322868: java/io/BufferedInputStream/TransferToTrusted.java has bad copyright header
  • 2cf5f01: 8322802: Add testing for ZipFile.getEntry respecting the 'Language encoding' flag
  • 38042ad: 8320971: Use BufferedInputStream.buf directly when param of implTransferTo() is trusted
  • ... and 10 more: https://git.openjdk.org/jdk/compare/518ec9711411e6825668f72503a2e96824cd37ba...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 openjdk bot added the ready Pull request is ready to be integrated label Jan 3, 2024
@dholmes-ora
Copy link
Member Author

Thanks for the review @AlanBateman !

@dholmes-ora
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Jan 3, 2024

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

  • 54b3cee: 8322877: java/io/BufferedInputStream/TransferTo.java failed with IndexOutOfBoundsException
  • 30a0c61: 8322879: Eliminate -Wparentheses warnings in x86-32 code
  • 409a39e: 8320276: Improve class initialization barrier in TemplateTable::_new
  • 296c5b6: 8322873: Duplicate -ljava -ljvm options for libinstrument
  • cc9ab5f: 8322963: ProblemList java/io/BufferedInputStream/TransferTo.java
  • 1551928: 8322142: JFR: Periodic tasks aren't orphaned between recordings
  • b67b71c: 8320707: Virtual thread test updates
  • 7eb25ec: 8322853: Should use ConditionalMutexLocker in NativeHeapTrimmerThread::print_state
  • 539da24: 8322779: C1: Remove the unused counter 'totalInstructionNodes'
  • a8e4229: 8322783: prioritize /etc/os-release over /etc/SuSE-release in hs_err/info output
  • ... and 23 more: https://git.openjdk.org/jdk/compare/518ec9711411e6825668f72503a2e96824cd37ba...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Jan 3, 2024

@dholmes-ora Pushed as commit 028ec7e.

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

@dholmes-ora dholmes-ora deleted the 8319948-jcmd branch January 4, 2024 00:34
@dholmes-ora
Copy link
Member Author

/backport jdk22

@openjdk
Copy link

openjdk bot commented Jan 4, 2024

@dholmes-ora Could not automatically backport 028ec7e7 to openjdk/jdk22 due to conflicts in the following files:

  • src/jdk.jcmd/share/man/jcmd.1

Please fetch the appropriate branch/commit and manually resolve these conflicts by using the following commands in your personal fork of openjdk/jdk22. Note: these commands are just some suggestions and you can use other equivalent commands you know.

# Fetch the up-to-date version of the target branch
$ git fetch --no-tags https://git.openjdk.org/jdk22.git master:master

# Check out the target branch and create your own branch to backport
$ git checkout master
$ git checkout -b backport-dholmes-ora-028ec7e7

# Fetch the commit you want to backport
$ git fetch --no-tags https://git.openjdk.org/jdk.git 028ec7e744f06cd8429b7b74d7b6f7020133aa94

# Backport the commit
$ git cherry-pick --no-commit 028ec7e744f06cd8429b7b74d7b6f7020133aa94
# Resolve conflicts now

# Commit the files you have modified
$ git add files/with/resolved/conflicts
$ git commit -m 'Backport 028ec7e744f06cd8429b7b74d7b6f7020133aa94'

Once you have resolved the conflicts as explained above continue with creating a pull request towards the openjdk/jdk22 with the title Backport 028ec7e744f06cd8429b7b74d7b6f7020133aa94.

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