On Thu, 5 Mar 2026 20:24:02 GMT, Ozan Cetin <[email protected]> wrote:

> Adds javadoc documentation for the javax.net.debug system property to the 
> javax.net.ssl    
> package, following the same pattern used for java.security.debug in the 
> java.security      
> package. A new doc-files/debug-system-property.html page is created 
> documenting all        
> supported options, and a link to it is added to the package-info.java.        
>              
>                                                                               
>              
> make docs-javadoc
> 
> Results:
> Finished building target 'docs-javadoc' in configuration 
> 'linux-x86_64-server-release'

See various comments.

src/java.base/share/classes/javax/net/ssl/doc-files/debug-system-property.html 
line 3:

> 1: <!doctype html>
> 2: <!--
> 3:  Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.

Copyright 2026.

src/java.base/share/classes/javax/net/ssl/doc-files/debug-system-property.html 
line 53:

> 51: <h1><B>{@systemProperty javax.net.debug}</B></h1>
> 52: <p> To monitor SSL/TLS activity, you can set the 
> <code>javax.net.debug</code>
> 53:     system property, which determines what trace messages are printed 
> during

trace->debug

src/java.base/share/classes/javax/net/ssl/doc-files/debug-system-property.html 
line 77:

> 75:     <tbody>
> 76:     <tr>
> 77:         <th scope="row"><code>all</code></th>

We spent a lot of time in 
[JDK-8044609](https://bugs.openjdk.org/browse/JDK-8044609) defining the table 
output for `javax.net.debug=help` to clearly explain the various options.  

Please use this order/format.

src/java.base/share/classes/javax/net/ssl/doc-files/debug-system-property.html 
line 82:

> 80:     <tr>
> 81:         <th scope="row"><code>ssl</code></th>
> 82:         <td>Turn on SSL debugging. If specified by itself, all 
> non-widening

New line after SSL debugging.  

I would encourage the remainder of this line be at the end like in the `help` 
message.

src/java.base/share/classes/javax/net/ssl/doc-files/debug-system-property.html 
line 95:

> 93:                     <ul>
> 94:                         <li><code><b>verbose</b></code>: Verbose handshake
> 95:                             message printing</li>

The three widening options are not indicated here, and thus doesn't make sense 
in this context.  

Please add them.

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

Changes requested by wetmore (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/30097#pullrequestreview-4011411038
PR Review Comment: https://git.openjdk.org/jdk/pull/30097#discussion_r2992458335
PR Review Comment: https://git.openjdk.org/jdk/pull/30097#discussion_r2992458481
PR Review Comment: https://git.openjdk.org/jdk/pull/30097#discussion_r2992501132
PR Review Comment: https://git.openjdk.org/jdk/pull/30097#discussion_r2992479351
PR Review Comment: https://git.openjdk.org/jdk/pull/30097#discussion_r2992504604

Reply via email to