RFR: 8328914: Document the java.security.debug property in javadoc [v6]
Weijun Wang
weijun at openjdk.org
Mon Feb 24 17:16:01 UTC 2025
On Fri, 21 Feb 2025 19:59:14 GMT, Koushik Muthukrishnan Thirupattur <duke at openjdk.org> wrote:
>> java.security.debug is a widely used debug system property for JDK security libs. It's time to capture details about this property via javadoc.
>>
>> 
>>
>>
>> NOTE : We are adding a new html file (similar to the Networking Properties [here](https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/net/doc-files/net-properties.html#networking-properties-heading)) for documenting security-related properties, and over time, we will add more properties to this page.
>
> 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 83:
> 81: <tr>
> 82: <th scope="row"><code>certpath</code></th>
> 83: <td>Turns on debugging for the PKIX CertPathValidator and CertPathBuilder implementations. Use the ocsp option with the certpath option for OCSP protocol tracing. A hexadecimal dump of the OCSP request and response bytes is displayed.
`ocsp` and `verbose` are sub-options. Same for `engine=` in `provider` and `ava` in `x509`.
src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 93:
> 91: <tr>
> 92: <th scope="row"><code>configfile</code></th>
> 93: <td><code>JAAS (Java Authentication and Authorization Service) configuration file loading</code></td>
These (and many below) do not need to be `<code>`.
src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 113:
> 111: <tr>
> 112: <th scope="row"><code>keystore</code></th>
> 113: <td><code>Keystore debugging</code></td>
Consider change to `KeyStore` to be consistent with rows below. I prefer them in `<code>`.
src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 197:
> 195: </p>
> 196: </body>
> 197: </html>
Add an empty line at the end.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1968077023
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1968059477
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1968078455
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1968079282
More information about the security-dev
mailing list