Re: RFR: 8179370: Replace use of , and tags in java.base

[Brad R. Wetmore]

Only comment is updating the copyright dates to 2017.

Brad




On 4/26/2017 6:23 PM, Mandy Chung wrote:

Looks okay.
Mandy


On Apr 26, 2017, at 5:50 PM, Jonathan Gibbons  
wrote:

Please review these mostly simple changes to replace HTML tags which are not 
valid in HTML 5 in public doc comments in java.base.

As with the previous changes, the changes were done mechanically, using the 
following sed script:

s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 style="text-align:center">\2|
s|||
s|||

The unusual form of the 3rd line was to cover the occurrence in a makefile.

The 4th line is specific for DataInput.java, and replaces  within a  with 
a style on the  element itself.

The 5th and 6th lines are specific to URLConnection. The use of the table 
itself and the ASCII art that follows it are questionable, but the intent here 
is just to update the HTML and not to rework the visual appearance of the 
generated documentation.

The changes cover files in the following packages:

java.base java/io
java.base java/net
java.base java/util
java.base javax/net/ssl


JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/

-- Jon

Re: RFR: 8179370: Replace use of , and tags in java.base

[Mandy Chung]

> On Apr 26, 2017, at 6:49 PM, Jonathan Gibbons  
> wrote:
> 
> Updated webrev to address Joe's suggestion to try harder to use {@code} as a 
> substitute for .
> 
> http://cr.openjdk.java.net/~jjg/8179370/webrev.01

Looks good.
Mandy

Re: RFR: 8179370: Replace use of , and tags in java.base

[Alan Bateman]

On 27/04/2017 02:49, Jonathan Gibbons wrote:
Updated webrev to address Joe's suggestion to try harder to use 
{@code} as a substitute for .


http://cr.openjdk.java.net/~jjg/8179370/webrev.01

The updated version using {@code ... } looks better and also keeps the 
lines from growing too long.


-Alan

Re: RFR: 8179370: Replace use of , and tags in java.base

[joe darcy]

Looks better; thanks Jon,

-Joe


On 4/26/2017 6:49 PM, Jonathan Gibbons wrote:
Updated webrev to address Joe's suggestion to try harder to use 
{@code} as a substitute for .


http://cr.openjdk.java.net/~jjg/8179370/webrev.01

The modified sed script has a new first line:

s|\([^&<>]*\)|{@code \1}|g
s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 
style="text-align:center">\2|
s|style="margin:0 auto" |

s|||
s|||

Also note that there is a small visible bug in webrev. If you look at 
ServiceLoader.java:133,
the second instance of  is not converted to {@code} because the 
embedded '\' is actually
an entity in the source file ... and so it is inappropriate to use 
{@code} for that instance.


-- Jon



On 04/26/2017 06:09 PM, Jonathan Gibbons wrote:

Joe,

Yes, there are occurrences here that require  instead of 
{@code}, because of the presence of HTML entities. It's about 50/50.


I'd prefer to stay with mechanical updates as much as possible for 
these bulk updates, as compared to manual updates, but I may be able 
to improve the sed script for this case.


-- Jon

On 04/26/2017 05:55 PM, Joseph D. Darcy wrote:

Hi Jon,

I'd prefer if the "foo" were replaced with "{@code tt}" 
rather than "foo"- none of the tricky cases which 
preclude use of {@code } use seem to be present here - but will 
approve the changeset in its current form too.


Cheers,

-Joe

On 4/26/2017 5:50 PM, Jonathan Gibbons wrote:
Please review these mostly simple changes to replace HTML tags 
which are not valid in HTML 5 in public doc comments in java.base.


As with the previous changes, the changes were done mechanically, 
using the following sed script:


s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 
style="text-align:center">\2|
s|style="margin:0 auto" |

s|||
s|||

The unusual form of the 3rd line was to cover the occurrence in a 
makefile.


The 4th line is specific for DataInput.java, and replaces  
within a  with a style on the  element itself.


The 5th and 6th lines are specific to URLConnection. The use of the 
table itself and the ASCII art that follows it are questionable, 
but the intent here is just to update the HTML and not to rework 
the visual appearance of the generated documentation.


The changes cover files in the following packages:

java.base java/io
java.base java/net
java.base java/util
java.base javax/net/ssl


JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/

-- Jon

Re: RFR: 8179370: Replace use of , and tags in java.base

[Jonathan Gibbons]

Updated webrev to address Joe's suggestion to try harder to use {@code} 
as a substitute for .


http://cr.openjdk.java.net/~jjg/8179370/webrev.01

The modified sed script has a new first line:

s|\([^&<>]*\)|{@code \1}|g
s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 style="text-align:center">\2|
s|
s|||
s|||

Also note that there is a small visible bug in webrev. If you look at 
ServiceLoader.java:133,
the second instance of  is not converted to {@code} because the 
embedded '\' is actually
an entity in the source file ... and so it is inappropriate to use 
{@code} for that instance.


-- Jon



On 04/26/2017 06:09 PM, Jonathan Gibbons wrote:

Joe,

Yes, there are occurrences here that require  instead of 
{@code}, because of the presence of HTML entities. It's about 50/50.


I'd prefer to stay with mechanical updates as much as possible for 
these bulk updates, as compared to manual updates, but I may be able 
to improve the sed script for this case.


-- Jon

On 04/26/2017 05:55 PM, Joseph D. Darcy wrote:

Hi Jon,

I'd prefer if the "foo" were replaced with "{@code tt}" 
rather than "foo"- none of the tricky cases which 
preclude use of {@code } use seem to be present here - but will 
approve the changeset in its current form too.


Cheers,

-Joe

On 4/26/2017 5:50 PM, Jonathan Gibbons wrote:
Please review these mostly simple changes to replace HTML tags which 
are not valid in HTML 5 in public doc comments in java.base.


As with the previous changes, the changes were done mechanically, 
using the following sed script:


s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 
style="text-align:center">\2|
s|style="margin:0 auto" |

s|||
s|||

The unusual form of the 3rd line was to cover the occurrence in a 
makefile.


The 4th line is specific for DataInput.java, and replaces  
within a  with a style on the  element itself.


The 5th and 6th lines are specific to URLConnection. The use of the 
table itself and the ASCII art that follows it are questionable, but 
the intent here is just to update the HTML and not to rework the 
visual appearance of the generated documentation.


The changes cover files in the following packages:

java.base java/io
java.base java/net
java.base java/util
java.base javax/net/ssl


JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/

-- Jon

Re: RFR: 8179370: Replace use of , and tags in java.base

[Mandy Chung]

Looks okay.
Mandy

> On Apr 26, 2017, at 5:50 PM, Jonathan Gibbons  
> wrote:
> 
> Please review these mostly simple changes to replace HTML tags which are not 
> valid in HTML 5 in public doc comments in java.base.
> 
> As with the previous changes, the changes were done mechanically, using the 
> following sed script:
> 
> s|||g
> s|||g
> s|<\\/tt>|<\\/code>|g
> s|\(]*\)>\([^<]*\)|\1 style="text-align:center">\2|
> s| |
> s|||
> s| s|||
> 
> The unusual form of the 3rd line was to cover the occurrence in a makefile.
> 
> The 4th line is specific for DataInput.java, and replaces  within a 
>  with a style on the  element itself.
> 
> The 5th and 6th lines are specific to URLConnection. The use of the table 
> itself and the ASCII art that follows it are questionable, but the intent 
> here is just to update the HTML and not to rework the visual appearance of 
> the generated documentation.
> 
> The changes cover files in the following packages:
> 
> java.base java/io
> java.base java/net
> java.base java/util
> java.base javax/net/ssl
> 
> 
> JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
> Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/
> 
> -- Jon

Re: RFR: 8179370: Replace use of , and tags in java.base

[Jonathan Gibbons]

Joe,

Yes, there are occurrences here that require  instead of {@code}, 
because of the presence of HTML entities. It's about 50/50.


I'd prefer to stay with mechanical updates as much as possible for these 
bulk updates, as compared to manual updates, but I may be able to 
improve the sed script for this case.


-- Jon

On 04/26/2017 05:55 PM, Joseph D. Darcy wrote:

Hi Jon,

I'd prefer if the "foo" were replaced with "{@code tt}" 
rather than "foo"- none of the tricky cases which 
preclude use of {@code } use seem to be present here - but will 
approve the changeset in its current form too.


Cheers,

-Joe

On 4/26/2017 5:50 PM, Jonathan Gibbons wrote:
Please review these mostly simple changes to replace HTML tags which 
are not valid in HTML 5 in public doc comments in java.base.


As with the previous changes, the changes were done mechanically, 
using the following sed script:


s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 
style="text-align:center">\2|
s|style="margin:0 auto" |

s|||
s|||

The unusual form of the 3rd line was to cover the occurrence in a 
makefile.


The 4th line is specific for DataInput.java, and replaces  
within a  with a style on the  element itself.


The 5th and 6th lines are specific to URLConnection. The use of the 
table itself and the ASCII art that follows it are questionable, but 
the intent here is just to update the HTML and not to rework the 
visual appearance of the generated documentation.


The changes cover files in the following packages:

java.base java/io
java.base java/net
java.base java/util
java.base javax/net/ssl


JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/

-- Jon

Re: RFR: 8179370: Replace use of , and tags in java.base

[Joseph D. Darcy]

Hi Jon,

I'd prefer if the "foo" were replaced with "{@code tt}" rather 
than "foo"- none of the tricky cases which preclude use of 
{@code } use seem to be present here - but will approve the changeset in 
its current form too.


Cheers,

-Joe

On 4/26/2017 5:50 PM, Jonathan Gibbons wrote:
Please review these mostly simple changes to replace HTML tags which 
are not valid in HTML 5 in public doc comments in java.base.


As with the previous changes, the changes were done mechanically, 
using the following sed script:


s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 
style="text-align:center">\2|
s|style="margin:0 auto" |

s|||
s|||

The unusual form of the 3rd line was to cover the occurrence in a 
makefile.


The 4th line is specific for DataInput.java, and replaces  
within a  with a style on the  element itself.


The 5th and 6th lines are specific to URLConnection. The use of the 
table itself and the ASCII art that follows it are questionable, but 
the intent here is just to update the HTML and not to rework the 
visual appearance of the generated documentation.


The changes cover files in the following packages:

java.base java/io
java.base java/net
java.base java/util
java.base javax/net/ssl


JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/

-- Jon

RFR: 8179370: Replace use of , and tags in java.base

[Jonathan Gibbons]

Please review these mostly simple changes to replace HTML tags which are 
not valid in HTML 5 in public doc comments in java.base.


As with the previous changes, the changes were done mechanically, using 
the following sed script:


s|||g
s|||g
s|<\\/tt>|<\\/code>|g
s|\(]*\)>\([^<]*\)|\1 style="text-align:center">\2|
s|
s|||
s|||

The unusual form of the 3rd line was to cover the occurrence in a makefile.

The 4th line is specific for DataInput.java, and replaces  
within a  with a style on the  element itself.


The 5th and 6th lines are specific to URLConnection. The use of the 
table itself and the ASCII art that follows it are questionable, but the 
intent here is just to update the HTML and not to rework the visual 
appearance of the generated documentation.


The changes cover files in the following packages:

java.base java/io
java.base java/net
java.base java/util
java.base javax/net/ssl


JBS: https://bugs.openjdk.java.net/browse/JDK-8179370
Webrev: http://cr.openjdk.java.net/~jjg/8179370/webrev/

-- Jon