RFR: 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
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? ------------- Commit messages: - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump Changes: https://git.openjdk.org/jdk/pull/16413/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8313710 Stats: 114 lines in 3 files changed: 0 ins; 0 del; 114 mod Patch: https://git.openjdk.org/jdk/pull/16413.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/16413/head:pull/16413 PR: https://git.openjdk.org/jdk/pull/16413
On Mon, 30 Oct 2023 08:46:08 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
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. ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1785551669
On Mon, 30 Oct 2023 16:09:50 GMT, Erik Gahlin <egahlin@openjdk.org> wrote:
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?
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.
@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? ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1829263058
On Mon, 30 Oct 2023 16:09:50 GMT, Erik Gahlin <egahlin@openjdk.org> wrote:
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?
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.
@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" ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1833597042
On Thu, 30 Nov 2023 11:37:07 GMT, Erik Gahlin <egahlin@openjdk.org> wrote:
@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. ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1869571223
On Mon, 30 Oct 2023 08:46:08 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
Changes requested by dholmes (Reviewer). src/jdk.jcmd/share/man/jcmd.1 line 1:
1: .\" Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
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. ------------- PR Review: https://git.openjdk.org/jdk/pull/16413#pullrequestreview-1705181772 PR Review Comment: https://git.openjdk.org/jdk/pull/16413#discussion_r1376871765
On Mon, 30 Oct 2023 22:39:34 GMT, David Holmes <dholmes@openjdk.org> wrote:
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?
src/jdk.jcmd/share/man/jcmd.1 line 1:
1: .\" Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
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? ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/16413#discussion_r1407338498
On Tue, 28 Nov 2023 07:38:06 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
src/jdk.jcmd/share/man/jcmd.1 line 1:
1: .\" Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
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 ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/16413#discussion_r1407344450
On Tue, 28 Nov 2023 07:44:27 GMT, David Holmes <dholmes@openjdk.org> wrote:
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. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/16413#discussion_r1436476251
On Tue, 28 Nov 2023 07:44:27 GMT, David Holmes <dholmes@openjdk.org> wrote:
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
@dholmes-ora Sorry for the late response again. I issued sub-task. https://bugs.openjdk.org/browse/JDK-8324089 ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/16413#discussion_r1457086198
On Mon, 30 Oct 2023 22:39:41 GMT, David Holmes <dholmes@openjdk.org> wrote:
Taizo Kurashige has updated the pull request incrementally with one additional commit since the last revision:
8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
Changes requested by dholmes (Reviewer).
@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. ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1918482452
On Wed, 31 Jan 2024 06:41:44 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
Changes requested by dholmes (Reviewer).
@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.
Thanks @kurashige23 , the manpage subtask will be handled by someone from Oracle. I'll leave it to JFR folk to do the review here. ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1920524186
On Thu, 1 Feb 2024 05:07:13 GMT, David Holmes <dholmes@openjdk.org> wrote:
@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.
Thanks @kurashige23 , the manpage subtask will be handled by someone from Oracle. I'll leave it to JFR folk to do the review here.
Thanks @dholmes-ora , I understood that the subtask will be handled by someone from Oracle.
I'll leave it to JFR folk to do the review here.
Does it mean that this pull request will not be merged until the subtask is resolved? ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1931341003
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?
Taizo Kurashige has updated the pull request incrementally with one additional commit since the last revision: 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump ------------- Changes: - all: https://git.openjdk.org/jdk/pull/16413/files - new: https://git.openjdk.org/jdk/pull/16413/files/a0f703e7..ec5b71ab Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=01 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=00-01 Stats: 2 lines in 1 file changed: 0 ins; 0 del; 2 mod Patch: https://git.openjdk.org/jdk/pull/16413.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/16413/head:pull/16413 PR: https://git.openjdk.org/jdk/pull/16413
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?
Taizo Kurashige has updated the pull request incrementally with one additional commit since the last revision: 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump ------------- Changes: - all: https://git.openjdk.org/jdk/pull/16413/files - new: https://git.openjdk.org/jdk/pull/16413/files/ec5b71ab..5fe59b39 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=02 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=01-02 Stats: 3 lines in 2 files changed: 0 ins; 0 del; 3 mod Patch: https://git.openjdk.org/jdk/pull/16413.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/16413/head:pull/16413 PR: https://git.openjdk.org/jdk/pull/16413
On Tue, 26 Dec 2023 14:15:17 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
Taizo Kurashige has updated the pull request incrementally with one additional commit since the last revision:
8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
Could someone please review this PR? (Or will the review be done after https://bugs.openjdk.org/browse/JDK-8324089 is resolved?) ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1965659547
On Tue, 26 Dec 2023 14:15:17 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
Taizo Kurashige has updated the pull request incrementally with one additional commit since the last revision:
8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
These changes seem fine to me. Hopefully @egahlin can also approve. BTW please merge your branch with master so that it is up to date. Thanks ------------- Marked as reviewed by dholmes (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/16413#pullrequestreview-1902559381 PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1965825683
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?
Taizo Kurashige has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision: - Merge branch 'openjdk:master' into JDK-8313710 - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump ------------- Changes: - all: https://git.openjdk.org/jdk/pull/16413/files - new: https://git.openjdk.org/jdk/pull/16413/files/5fe59b39..25b64b56 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=03 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=16413&range=02-03 Stats: 952317 lines in 8146 files changed: 263136 ins; 580602 del; 108579 mod Patch: https://git.openjdk.org/jdk/pull/16413.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/16413/head:pull/16413 PR: https://git.openjdk.org/jdk/pull/16413
On Tue, 27 Feb 2024 08:06:18 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
Taizo Kurashige has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:
- Merge branch 'openjdk:master' into JDK-8313710 - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
I merged my branch with master. Thanks. ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1965991239
On Tue, 27 Feb 2024 08:06:18 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
Taizo Kurashige has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:
- Merge branch 'openjdk:master' into JDK-8313710 - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
Looks good. Thanks for fixing this. I can sponsor the change. ------------- Marked as reviewed by egahlin (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/16413#pullrequestreview-1903021556
On Tue, 27 Feb 2024 08:06:18 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
Taizo Kurashige has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:
- Merge branch 'openjdk:master' into JDK-8313710 - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump - 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
Thanks for review. ------------- PR Comment: https://git.openjdk.org/jdk/pull/16413#issuecomment-1966250736
On Mon, 30 Oct 2023 08:46:08 GMT, Taizo Kurashige <duke@openjdk.org> wrote:
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?
This pull request has now been integrated. Changeset: 16d917a8 Author: Taizo Kurashige <103394724+kurashige23@users.noreply.github.com> Committer: Erik Gahlin <egahlin@openjdk.org> URL: https://git.openjdk.org/jdk/commit/16d917a85f9311611a14a63f1e53afae970efc73 Stats: 113 lines in 2 files changed: 0 ins; 0 del; 113 mod 8313710: jcmd: typo in the documentation of JFR.start and JFR.dump Reviewed-by: dholmes, egahlin ------------- PR: https://git.openjdk.org/jdk/pull/16413
participants (3)
-
David Holmes
-
Erik Gahlin
-
Taizo Kurashige