RFR [15] 8237817: Clean up net-properties.html

Pavel Rappo pavel.rappo at oracle.com
Fri Jan 24 12:31:58 UTC 2020


Hello,

Please review the following change for https://bugs.openjdk.java.net/browse/JDK-8237817:

   http://cr.openjdk.java.net/~prappo/8237817/webrev.00/

Below are some explanations and reasoning behind the change.

1. Not only do the things that are marked up as "code" have a different look, in
some contexts they should be copy-paste friendly. Command-line options are a
good example of that. The command-line options described in net-properties.html
are not copy-paste friendly, because they use quotation marks which are not
recognized by the shell. Quotes are necessary to shield from possible
shell expansion. Fixed.

While applying "code" markup to default values of the properties I did not apply
it to <none>. This is because it is not "code" and should not be interpreted
literally.

2. java.net.Authenticator is mentioned multiple times on that page.
I believe it deserves to be hyperlinked once.

3. Grammar and typos (hyphens, spaces, punctuation). It is worth mentioning that
some quotes were not properly nested. Sometimes the enclosing was done using
2 left or 2 right quotes.

4. I tried to fix the below sentence by adding, what I believe, a missing "for":

    This is to ensure backward compatibility, for example, for applications
    that depend on the representation of an IPv4 address (e.g. 192.168.1.1).

Maybe it could be broken into two sentences? (See the changed sentence about the
SOCKS protocol versions.) Maybe native speakers or any folks with good English
could help me out with it.

Thanks,
-Pavel



More information about the net-dev mailing list