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

Sean Mullan mullan at openjdk.org
Thu Feb 20 21:52:55 UTC 2025


On Wed, 19 Feb 2025 23:27:19 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.
>> 
>> ![image](https://github.com/user-attachments/assets/bf8bb8bf-a63b-4b14-9790-783fa8c9c080)
>> 
>> 
>> 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 two additional commits since the last revision:
> 
>  - 8328914: Document the java.security.debug property in javadoc
>  - 8328914: Document the java.security.debug property in javadoc

src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 66:

> 64:         which determines what trace messages are printed during execution.
> 65:         To view security properties, security providers, and TLS-related settings,
> 66:         specify the -XshowSettings:security option in the java command.

This sentence seems out-of-place here. While I think it is useful to mention this, it has nothing to do with the `java.security.debug` property, so it seems a little confusing, and I suggest we not include it right now. Perhaps we can add another section on security related VM options later.

src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html line 67:

> 65:         To view security properties, security providers, and TLS-related settings,
> 66:         specify the -XshowSettings:security option in the java command.
> 67:         You can enable debugging in JGSS and other related technologies with various system properties or environment variables.

This is referring to other system properties like `sun.security.jgss.debug`. Since we are not documenting those other properties here (yet), we should remove this sentence.

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

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


More information about the security-dev mailing list