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

Weijun Wang weijun at openjdk.org
Thu Feb 20 01:02:56 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

The `+thread` and `+timestamp` are modifiers that can be added to any value. I'd like them to be described outside the table.

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

> 53:     There are several system properties used to
> 54:     alter the mechanisms and behavior of the various classes of the
> 55:     java.security package. Some are checked only once at startup of the VM,

Code, identifiers and command line options like `java.security`, `-D`, `-XshowSettings:security`, etc should be shown in fixed-width.

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

> 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.
> 68:         The following table lists java.security.debug options table:</p>

Do you want to show some examples on how the options are specified? Especially when there are multiple options.

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

PR Comment: https://git.openjdk.org/jdk/pull/23569#issuecomment-2670120348
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1962597531
PR Review Comment: https://git.openjdk.org/jdk/pull/23569#discussion_r1962598898


More information about the security-dev mailing list