RFR: 8328914: Document the java.security.debug property in javadoc [v9]

Tue Feb 25 18:53:34 UTC 2025

On Tue, 25 Feb 2025 15:23:20 GMT, Weijun Wang <weijun at openjdk.org> wrote:

>> Koushik Muthukrishnan Thirupattur has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8328914: Document the java.security.debug property in javadoc
>
> src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 29:
> 
>> 27: <head>
>> 28:     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
>> 29:     <title>Security-Related System Property</title>
> 
> Not what I expected. Either you keep the old name and add a few new system properties, or, just change the whole title to something like "Troubleshooting" or "Printing Debug Information".

This was the title recommended by Sean above as we want to initially create this file for security related system properties. We are going to be adding more to it later as needed like he mentioned but for now we will just have the debug. Let me know if this still needs a more suitable title.

> src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 63:
> 
>> 61: <H2>Debug</H2>
>> 62: <p><B>{@systemProperty java.security.debug}</B><BR></p>
>> 63: <H2>Printing Thread and Timestamp Information</H2>
> 
> This is still a big `<H2>`, which is at the same level as `<H2>Debug</H2>`.

Reduced to H3.

> src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 79:
> 
>> 77:             which determines what trace messages are printed during execution. The value of the property is one or more options separated by a comma.
>> 78:             Some options also have additional sub-options. Sub-options are specified by appending a ":" to the option, followed by a list of one more sub-options separated by a comma.
>> 79:             For example, to specify the <code>ocsp</code> and <code>verbose</code> options with the <code>certpath</code> option: set the property to <code>"certpath:ocsp,verbose"</code>.
> 
> Do we need `"` inside `<code>`?

Changed.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1970353599
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1970349655
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1970350802