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

[Erik Gahlin]

On Mon, 30 Oct 2023 16:09:50 GMT, Erik Gahlin <egahlin at 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