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

Tue Feb 25 22:38:59 UTC 2025

On Tue, 25 Feb 2025 18:50:44 GMT, Koushik Muthukrishnan Thirupattur <duke at openjdk.org> wrote:

>> 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.

Ok, so I don't like "Security-Related System Property" because you would not need a title like that for one property. The overall intent of this document is to use it as a place to document more system properties, but if we have no immediate plans to do that within the JDK 25 timeframe, then maybe a more specific title like what Weijun is suggesting is more appropriate.

There are many other security related system properties which are worth documenting but more of them are in the TLS and Kerberos areas, which are in different packages or modules. I'm not sure if we need different html pages for each of those areas. I was really hoping we would have one page for all security library areas.

Let me think about this more first.

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

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