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

[Koushik Muthukrishnan Thirupattur]

On Mon, 24 Feb 2025 21:19:19 GMT, Sean Mullan <mullan at openjdk.org> wrote:

>> src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 65:
>> 
>>> 63:         <p> To monitor security access, you can set the <code>java.security.debug</code> system property,
>>> 64:             which determines what trace messages are printed during execution. The value of the property is one or more options separated by a comma.
>>> 65:             Some options also have additional sub-options; see the list below for more details on the syntax of each.
>> 
>> Do we want to state a syntax for sub-options? The implementation is very flexible, it just searches for the sub-option. But I think the de-facto syntax is the option, a ":" and then a list of one more more sub-options separated by a comma. Ex: java.security.debug=certpath:ocsp,verbose
>
> I suggest we say something like the following, and also give an example:
> 
> Sub-options are specified by appending a ":" to the option, followed by a list of one more sub-options separated by a comma. For example, to specify the `ocsp` and `verbose` options with the `certpath` option: set the property to "certpath:ocsp,verbose".

Updated.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1968620373