8313710: jcmd: typo in the documentation of JFR.start and JFR.dump #16413

kurashige23 · 2023-10-30T08:46:08Z

Hi,

I fixed the typos for JFR.start and JFR.dump.
Acconding to issue's description, there is some typo in JFR.stop documentation, but I couldn't find that. I confirmed that there is no such typo in this repository. So I thought there was no need to fix JFR.stop documentation.

I confirmed that the fixes are reflected and that all of the jdk_jfr tests pass.

Could someone please review it?

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-8313710: jcmd: typo in the documentation of JFR.start and JFR.dump (Bug - P5)

Reviewers

David Holmes (@dholmes-ora - Reviewer)
Erik Gahlin (@egahlin - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16413

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2023-10-30T08:47:46Z

👋 Welcome back kurashige23! 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 · 2023-10-30T08:49:49Z

@kurashige23 The following labels will be automatically applied to this pull request:

hotspot-jfr
serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2023-10-30T08:52:58Z

Webrevs

egahlin · 2023-10-30T16:09:50Z

Looks like the added character and shift to the right will make the description exceed 80 characters in some lines, for example "included" for the begin option.

dholmes-ora · 2023-10-30T22:39:34Z

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

This file is generated from markdown sources that Oracle has to maintain. Please work with an Oracle engineer to get the changes applied to that source and then regenerate the jcmd.1 nroff file. You can split this into a separate sub-task if needed.

Thank you for telling me about how to jcmd.1 nroff file is managed.
I will split this change into separate subtasks. Then if one of the Oracle engineers finds that subtask, will he/she work on it like any other bug?

Yes it will be assigned and addressed. Thanks

Sorry for the late response.

I will ask my colleague to make it, so please wait a moment.

@dholmes-ora
Sorry for the late response again.
I issued sub-task.
https://bugs.openjdk.org/browse/JDK-8324089

bridgekeeper · 2023-11-27T23:48:03Z

@kurashige23 This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

kurashige23 · 2023-11-28T07:37:37Z

@egahlin

Looks like the added character and shift to the right will make the description exceed 80 characters in some lines, for example "included" for the begin option.

I'm sorry, I don't know from which letter to which letter is more than 80 characters, for example in line of begin option. Can you tell me that?
Also, I didn't know the rule that the number of characters per line should not exceed 80. If possible, could you please tell me where such a rule is stated?

egahlin · 2023-11-30T11:37:07Z

@egahlin

Looks like the added character and shift to the right will make the description exceed 80 characters in some lines, for example "included" for the begin option.

I'm sorry, I don't know from which letter to which letter is more than 80 characters, for example in line of begin option. Can you tell me that? Also, I didn't know the rule that the number of characters per line should not exceed 80. If possible, could you please tell me where such a rule is stated?

You could look at line 319 in DCmdStart.java and 198 in DcmdDump.java. Make sure characters don't exceed. "...1234567890"

kurashige23 · 2023-12-26T14:09:37Z

@egahlin

Looks like the added character and shift to the right will make the description exceed 80 characters in some lines, for example "included" for the begin option.

I'm sorry, I don't know from which letter to which letter is more than 80 characters, for example in line of begin option. Can you tell me that? Also, I didn't know the rule that the number of characters per line should not exceed 80. If possible, could you please tell me where such a rule is stated?

You could look at line 319 in DCmdStart.java and 198 in DcmdDump.java. Make sure characters don't exceed. "...1234567890"

Sorry for the late response.

Thanks, I understand that characters should not exceed "... 1234567890" (88 characters) .
I fixed line 204 in DcmdDump.java.
In addition, the starting position of "...1234567890" in DcmdStart.java does not match the beginning of "Syntax :..", and it is hard to see visually whether characters exceed "...1234567890". So I fixed it.

kurashige23 · 2024-01-31T06:41:44Z

@dholmes-ora @egahlin

I'm sorry that my slow response has prolonged this issue. I created a subtask and modified the source. If possible, please review them.

dholmes-ora · 2024-02-01T05:07:13Z

Thanks @kurashige23 , the manpage subtask will be handled by someone from Oracle. I'll leave it to JFR folk to do the review here.

kurashige23 · 2024-02-27T02:06:52Z

Could someone please review this PR?
(Or will the review be done after https://bugs.openjdk.org/browse/JDK-8324089 is resolved?)

dholmes-ora

These changes seem fine to me.

Hopefully @egahlin can also approve.

openjdk · 2024-02-27T05:38:15Z

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

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump

Reviewed-by: dholmes, egahlin

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

da14aa4: 8017234: Hotspot should stop using mapfiles
d482c1a: 8326524: Rename agent_common.h
e85355a: 8320005: Allow loading of shared objects with .a extension on AIX
5d3d40d: 8326659: Serial: Remove redundant TenuredSpace::print_on
7583419: 8324828: Avoid multiple search of reserved regions during splitting
c5f1dcc: 8325082: Rename headers named 'heapRegion*' of G1
4d82ea1: 8325144: C1: Optimize CriticalEdgeFinder
a48f596: 8322179: RISC-V: Implement SHA-1 intrinsic
5daf63b: 8326636: Problem list StartupOutput.java due to 8326615

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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 (@dholmes-ora, @egahlin) 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 · 2024-02-27T05:38:58Z

BTW please merge your branch with master so that it is up to date. Thanks

kurashige23 · 2024-02-27T08:07:26Z

I merged my branch with master. Thanks.

egahlin

Looks good. Thanks for fixing this. I can sponsor the change.

kurashige23 · 2024-02-27T10:33:18Z

Thanks for review.

/integrate

openjdk · 2024-02-27T10:34:28Z

@kurashige23
Your change (at version 25b64b5) is now ready to be sponsored by a Committer.

egahlin · 2024-02-27T10:39:01Z

/sponsor

openjdk · 2024-02-27T10:39:50Z

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

60cbf29: 8325754: Dead AbstractQueuedSynchronizer$ConditionNodes survive minor garbage collections
da14aa4: 8017234: Hotspot should stop using mapfiles
d482c1a: 8326524: Rename agent_common.h
e85355a: 8320005: Allow loading of shared objects with .a extension on AIX
5d3d40d: 8326659: Serial: Remove redundant TenuredSpace::print_on
7583419: 8324828: Avoid multiple search of reserved regions during splitting
c5f1dcc: 8325082: Rename headers named 'heapRegion*' of G1
4d82ea1: 8325144: C1: Optimize CriticalEdgeFinder
a48f596: 8322179: RISC-V: Implement SHA-1 intrinsic
5daf63b: 8326636: Problem list StartupOutput.java due to 8326615

Your commit was automatically rebased without conflicts.

openjdk · 2024-02-27T10:39:57Z

@egahlin @kurashige23 Pushed as commit 16d917a.

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

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump

a0f703e

openjdk bot added the rfr Pull request is ready for review label Oct 30, 2023

openjdk bot added serviceability serviceability-dev@openjdk.org hotspot-jfr hotspot-jfr-dev@openjdk.org labels Oct 30, 2023

dholmes-ora suggested changes Oct 30, 2023

View reviewed changes

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump

ec5b71a

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump

5fe59b3

dholmes-ora approved these changes Feb 27, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Feb 27, 2024

Merge branch 'openjdk:master' into JDK-8313710

25b64b5

egahlin approved these changes Feb 27, 2024

View reviewed changes

openjdk bot added the sponsor Pull request is ready to be sponsored label Feb 27, 2024

openjdk bot added the integrated Pull request has been integrated label Feb 27, 2024

openjdk bot closed this Feb 27, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels Feb 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump #16413

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump #16413

kurashige23 commented Oct 30, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Oct 30, 2023

openjdk bot commented Oct 30, 2023

mlbridge bot commented Oct 30, 2023 •

edited

Loading

egahlin commented Oct 30, 2023

dholmes-ora Oct 30, 2023

kurashige23 Nov 28, 2023

dholmes-ora Nov 28, 2023

kurashige23 Dec 26, 2023

kurashige23 Jan 18, 2024

bridgekeeper bot commented Nov 27, 2023

kurashige23 commented Nov 28, 2023

egahlin commented Nov 30, 2023

kurashige23 commented Dec 26, 2023 •

edited

Loading

kurashige23 commented Jan 31, 2024

dholmes-ora commented Feb 1, 2024

kurashige23 commented Feb 27, 2024

dholmes-ora left a comment

openjdk bot commented Feb 27, 2024 •

edited

Loading

dholmes-ora commented Feb 27, 2024

kurashige23 commented Feb 27, 2024

egahlin left a comment •

edited

Loading

kurashige23 commented Feb 27, 2024

openjdk bot commented Feb 27, 2024

egahlin commented Feb 27, 2024

openjdk bot commented Feb 27, 2024

openjdk bot commented Feb 27, 2024

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump #16413

8313710: jcmd: typo in the documentation of JFR.start and JFR.dump #16413

Conversation

kurashige23 commented Oct 30, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Oct 30, 2023

openjdk bot commented Oct 30, 2023

mlbridge bot commented Oct 30, 2023 • edited Loading

Webrevs

egahlin commented Oct 30, 2023

dholmes-ora Oct 30, 2023

Choose a reason for hiding this comment

kurashige23 Nov 28, 2023

Choose a reason for hiding this comment

dholmes-ora Nov 28, 2023

Choose a reason for hiding this comment

kurashige23 Dec 26, 2023

Choose a reason for hiding this comment

kurashige23 Jan 18, 2024

Choose a reason for hiding this comment

bridgekeeper bot commented Nov 27, 2023

kurashige23 commented Nov 28, 2023

egahlin commented Nov 30, 2023

kurashige23 commented Dec 26, 2023 • edited Loading

kurashige23 commented Jan 31, 2024

dholmes-ora commented Feb 1, 2024

kurashige23 commented Feb 27, 2024

dholmes-ora left a comment

Choose a reason for hiding this comment

openjdk bot commented Feb 27, 2024 • edited Loading

dholmes-ora commented Feb 27, 2024

kurashige23 commented Feb 27, 2024

egahlin left a comment • edited Loading

Choose a reason for hiding this comment

kurashige23 commented Feb 27, 2024

openjdk bot commented Feb 27, 2024

egahlin commented Feb 27, 2024

openjdk bot commented Feb 27, 2024

openjdk bot commented Feb 27, 2024

kurashige23 commented Oct 30, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Oct 30, 2023 •

edited

Loading

kurashige23 commented Dec 26, 2023 •

edited

Loading

openjdk bot commented Feb 27, 2024 •

edited

Loading

egahlin left a comment •

edited

Loading