JDK-8187447: 2081 doc issues in jvmti.html

classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

JDK-8187447: 2081 doc issues in jvmti.html

Alex Menkov-2
Hi,

Please review a fix for doc issue.

jira: https://bugs.openjdk.java.net/browse/JDK-8187447
webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/

old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html

specdiff reports no changes:
http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html

The fix:
- converts jvmti.html from HTML4 to HTML5;
- fixes all errors and almost all warnings reported by tidy and W3C HTML
Validator:
   - empty <p>;
   - unsupported attributes (align, border, width, cellpadding,
cellspacing, noshade, size, bgcolor, type);
   - <dl> without nested <dt>;
   - <a> with "name" attribute;
   - table with column with no cells beginning in it (all cells have
colspan=2);
- adds "lang" attribute for <html> (accessibility issue).

The only remaining warning (reported by W3C HTML Validator) is
   Warning: Documents should not use about:legacy-compat, except if
generated by legacy systems that can't output the standard <!DOCTYPE
html> doctype.
This is expected as the DOCTYPE legacy string
(http://w3c.github.io/html/single-page.html#doctype-legacy-string) was
added to HTML5 standard to handle issue with XLST which cannot produce
standard doctype.

--alex
Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

Alex Menkov-2
Updated the fix after offline discussion with Serguei:
http://cr.openjdk.java.net/~amenkov/8187447/webrev.01/

changes:
rollback replacement <p/> with <sep/> in jvmti.xml,
handle the case by transform in jvmti.xsl

Resulting jvmti.html is exactly the same.

--alex

On 01/11/2018 17:21, Alex Menkov wrote:

> Hi,
>
> Please review a fix for doc issue.
>
> jira: https://bugs.openjdk.java.net/browse/JDK-8187447
> webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
>
> old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
> new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
>
> specdiff reports no changes:
> http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
>
> The fix:
> - converts jvmti.html from HTML4 to HTML5;
> - fixes all errors and almost all warnings reported by tidy and W3C HTML
> Validator:
>    - empty <p>;
>    - unsupported attributes (align, border, width, cellpadding,
> cellspacing, noshade, size, bgcolor, type);
>    - <dl> without nested <dt>;
>    - <a> with "name" attribute;
>    - table with column with no cells beginning in it (all cells have
> colspan=2);
> - adds "lang" attribute for <html> (accessibility issue).
>
> The only remaining warning (reported by W3C HTML Validator) is
>    Warning: Documents should not use about:legacy-compat, except if
> generated by legacy systems that can't output the standard <!DOCTYPE
> html> doctype.
> This is expected as the DOCTYPE legacy string
> (http://w3c.github.io/html/single-page.html#doctype-legacy-string) was
> added to HTML5 standard to handle issue with XLST which cannot produce
> standard doctype.
>
> --alex
Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

serguei.spitsyn@oracle.com
In reply to this post by Alex Menkov-2
Hi Alex,

The fix is pretty impressive.
Thank you for taking care about all these html issues!

I'd like to ask about one thing.
The renaming of the <p> element into <sep> in the jvmti.xml is not
that necessary but is very intrusive as it impacts too many places.
Could you, please, keep these elements as they are for now?

Thanks,
Serguei


On 1/11/18 17:21, Alex Menkov wrote:

> Hi,
>
> Please review a fix for doc issue.
>
> jira: https://bugs.openjdk.java.net/browse/JDK-8187447
> webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
>
> old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
> new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
>
> specdiff reports no changes:
> http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
>
> The fix:
> - converts jvmti.html from HTML4 to HTML5;
> - fixes all errors and almost all warnings reported by tidy and W3C
> HTML Validator:
>   - empty <p>;
>   - unsupported attributes (align, border, width, cellpadding,
> cellspacing, noshade, size, bgcolor, type);
>   - <dl> without nested <dt>;
>   - <a> with "name" attribute;
>   - table with column with no cells beginning in it (all cells have
> colspan=2);
> - adds "lang" attribute for <html> (accessibility issue).
>
> The only remaining warning (reported by W3C HTML Validator) is
>   Warning: Documents should not use about:legacy-compat, except if
> generated by legacy systems that can't output the standard <!DOCTYPE
> html> doctype.
> This is expected as the DOCTYPE legacy string
> (http://w3c.github.io/html/single-page.html#doctype-legacy-string) was
> added to HTML5 standard to handle issue with XLST which cannot produce
> standard doctype.
>
> --alex

Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

serguei.spitsyn@oracle.com
In reply to this post by Alex Menkov-2
Thanks, Alex!
Serguei


On 1/12/18 17:05, Alex Menkov wrote:

> Updated the fix after offline discussion with Serguei:
> http://cr.openjdk.java.net/~amenkov/8187447/webrev.01/
>
> changes:
> rollback replacement <p/> with <sep/> in jvmti.xml,
> handle the case by transform in jvmti.xsl
>
> Resulting jvmti.html is exactly the same.
>
> --alex
>
> On 01/11/2018 17:21, Alex Menkov wrote:
>> Hi,
>>
>> Please review a fix for doc issue.
>>
>> jira: https://bugs.openjdk.java.net/browse/JDK-8187447
>> webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
>>
>> old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
>> new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
>>
>> specdiff reports no changes:
>> http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
>>
>> The fix:
>> - converts jvmti.html from HTML4 to HTML5;
>> - fixes all errors and almost all warnings reported by tidy and W3C
>> HTML Validator:
>>    - empty <p>;
>>    - unsupported attributes (align, border, width, cellpadding,
>> cellspacing, noshade, size, bgcolor, type);
>>    - <dl> without nested <dt>;
>>    - <a> with "name" attribute;
>>    - table with column with no cells beginning in it (all cells have
>> colspan=2);
>> - adds "lang" attribute for <html> (accessibility issue).
>>
>> The only remaining warning (reported by W3C HTML Validator) is
>>    Warning: Documents should not use about:legacy-compat, except if
>> generated by legacy systems that can't output the standard <!DOCTYPE
>> html> doctype.
>> This is expected as the DOCTYPE legacy string
>> (http://w3c.github.io/html/single-page.html#doctype-legacy-string)
>> was added to HTML5 standard to handle issue with XLST which cannot
>> produce standard doctype.
>>
>> --alex

Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

serguei.spitsyn@oracle.com
In reply to this post by Alex Menkov-2
Alex,

Looks great!

Thank you for the update!
Serguei


On 1/12/18 17:05, Alex Menkov wrote:

> Updated the fix after offline discussion with Serguei:
> http://cr.openjdk.java.net/~amenkov/8187447/webrev.01/
>
> changes:
> rollback replacement <p/> with <sep/> in jvmti.xml,
> handle the case by transform in jvmti.xsl
>
> Resulting jvmti.html is exactly the same.
>
> --alex
>
> On 01/11/2018 17:21, Alex Menkov wrote:
>> Hi,
>>
>> Please review a fix for doc issue.
>>
>> jira: https://bugs.openjdk.java.net/browse/JDK-8187447
>> webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
>>
>> old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
>> new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
>>
>> specdiff reports no changes:
>> http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
>>
>> The fix:
>> - converts jvmti.html from HTML4 to HTML5;
>> - fixes all errors and almost all warnings reported by tidy and W3C
>> HTML Validator:
>>    - empty <p>;
>>    - unsupported attributes (align, border, width, cellpadding,
>> cellspacing, noshade, size, bgcolor, type);
>>    - <dl> without nested <dt>;
>>    - <a> with "name" attribute;
>>    - table with column with no cells beginning in it (all cells have
>> colspan=2);
>> - adds "lang" attribute for <html> (accessibility issue).
>>
>> The only remaining warning (reported by W3C HTML Validator) is
>>    Warning: Documents should not use about:legacy-compat, except if
>> generated by legacy systems that can't output the standard <!DOCTYPE
>> html> doctype.
>> This is expected as the DOCTYPE legacy string
>> (http://w3c.github.io/html/single-page.html#doctype-legacy-string)
>> was added to HTML5 standard to handle issue with XLST which cannot
>> produce standard doctype.
>>
>> --alex

Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

Daniil Titov
In reply to this post by Alex Menkov-2
Hi Alex,

The fix looks good.  The only question I have is regarding the changes in jvmti.xml where <blockquote> element was introduced, e.g.:
-            <dl><dd><table>
+            <blockquote><table>

<blockquote> element indicates a block of text quoted from an external source so if this element was used here for indentation purposes only probably it makes sense to consider using a regular <div> element instead?

For example: <div style="margin-left:40px">some content</div>

Thanks!
           
Best regards,
Daniil


On 1/12/18, 5:06 PM, "serviceability-dev on behalf of Alex Menkov" <[hidden email] on behalf of [hidden email]> wrote:

    Updated the fix after offline discussion with Serguei:
    http://cr.openjdk.java.net/~amenkov/8187447/webrev.01/
   
    changes:
    rollback replacement <p/> with <sep/> in jvmti.xml,
    handle the case by transform in jvmti.xsl
   
    Resulting jvmti.html is exactly the same.
   
    --alex
   
    On 01/11/2018 17:21, Alex Menkov wrote:
    > Hi,
    >
    > Please review a fix for doc issue.
    >
    > jira: https://bugs.openjdk.java.net/browse/JDK-8187447
    > webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
    >
    > old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
    > new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
    >
    > specdiff reports no changes:
    > http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
    >
    > The fix:
    > - converts jvmti.html from HTML4 to HTML5;
    > - fixes all errors and almost all warnings reported by tidy and W3C HTML
    > Validator:
    >    - empty <p>;
    >    - unsupported attributes (align, border, width, cellpadding,
    > cellspacing, noshade, size, bgcolor, type);
    >    - <dl> without nested <dt>;
    >    - <a> with "name" attribute;
    >    - table with column with no cells beginning in it (all cells have
    > colspan=2);
    > - adds "lang" attribute for <html> (accessibility issue).
    >
    > The only remaining warning (reported by W3C HTML Validator) is
    >    Warning: Documents should not use about:legacy-compat, except if
    > generated by legacy systems that can't output the standard <!DOCTYPE
    > html> doctype.
    > This is expected as the DOCTYPE legacy string
    > (http://w3c.github.io/html/single-page.html#doctype-legacy-string) was
    > added to HTML5 standard to handle issue with XLST which cannot produce
    > standard doctype.
    >
    > --alex
   
   


Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

Alex Menkov-2


On 01/16/2018 12:11, Daniil Titov wrote:
> Hi Alex,
>
> The fix looks good.  The only question I have is regarding the changes in jvmti.xml where <blockquote> element was introduced, e.g.:
> -            <dl><dd><table>
> +            <blockquote><table>
>
> <blockquote> element indicates a block of text quoted from an external source so if this element was used here for indentation purposes only probably it makes sense to consider using a regular <div> element instead?

I used <blockquote> for consistency - in other similar places
<blockquote> is used for indentation.

--alex

>
> For example: <div style="margin-left:40px">some content</div>
>
> Thanks!
>              
> Best regards,
> Daniil
>
>
> On 1/12/18, 5:06 PM, "serviceability-dev on behalf of Alex Menkov" <[hidden email] on behalf of [hidden email]> wrote:
>
>      Updated the fix after offline discussion with Serguei:
>      http://cr.openjdk.java.net/~amenkov/8187447/webrev.01/
>      
>      changes:
>      rollback replacement <p/> with <sep/> in jvmti.xml,
>      handle the case by transform in jvmti.xsl
>      
>      Resulting jvmti.html is exactly the same.
>      
>      --alex
>      
>      On 01/11/2018 17:21, Alex Menkov wrote:
>      > Hi,
>      >
>      > Please review a fix for doc issue.
>      >
>      > jira: https://bugs.openjdk.java.net/browse/JDK-8187447
>      > webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
>      >
>      > old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
>      > new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
>      >
>      > specdiff reports no changes:
>      > http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
>      >
>      > The fix:
>      > - converts jvmti.html from HTML4 to HTML5;
>      > - fixes all errors and almost all warnings reported by tidy and W3C HTML
>      > Validator:
>      >    - empty <p>;
>      >    - unsupported attributes (align, border, width, cellpadding,
>      > cellspacing, noshade, size, bgcolor, type);
>      >    - <dl> without nested <dt>;
>      >    - <a> with "name" attribute;
>      >    - table with column with no cells beginning in it (all cells have
>      > colspan=2);
>      > - adds "lang" attribute for <html> (accessibility issue).
>      >
>      > The only remaining warning (reported by W3C HTML Validator) is
>      >    Warning: Documents should not use about:legacy-compat, except if
>      > generated by legacy systems that can't output the standard <!DOCTYPE
>      > html> doctype.
>      > This is expected as the DOCTYPE legacy string
>      > (http://w3c.github.io/html/single-page.html#doctype-legacy-string) was
>      > added to HTML5 standard to handle issue with XLST which cannot produce
>      > standard doctype.
>      >
>      > --alex
>      
>      
>
>
Reply | Threaded
Open this post in threaded view
|

Re: JDK-8187447: 2081 doc issues in jvmti.html

Daniil Titov
Got it.

+1

Thanks!

Best regards,
Daniil

On 1/16/18, 1:00 PM, "Alex Menkov" <[hidden email]> wrote:

   
   
    On 01/16/2018 12:11, Daniil Titov wrote:
    > Hi Alex,
    >
    > The fix looks good.  The only question I have is regarding the changes in jvmti.xml where <blockquote> element was introduced, e.g.:
    > -            <dl><dd><table>
    > +            <blockquote><table>
    >
    > <blockquote> element indicates a block of text quoted from an external source so if this element was used here for indentation purposes only probably it makes sense to consider using a regular <div> element instead?
   
    I used <blockquote> for consistency - in other similar places
    <blockquote> is used for indentation.
   
    --alex
   
    >
    > For example: <div style="margin-left:40px">some content</div>
    >
    > Thanks!
    >              
    > Best regards,
    > Daniil
    >
    >
    > On 1/12/18, 5:06 PM, "serviceability-dev on behalf of Alex Menkov" <[hidden email] on behalf of [hidden email]> wrote:
    >
    >      Updated the fix after offline discussion with Serguei:
    >      http://cr.openjdk.java.net/~amenkov/8187447/webrev.01/
    >      
    >      changes:
    >      rollback replacement <p/> with <sep/> in jvmti.xml,
    >      handle the case by transform in jvmti.xsl
    >      
    >      Resulting jvmti.html is exactly the same.
    >      
    >      --alex
    >      
    >      On 01/11/2018 17:21, Alex Menkov wrote:
    >      > Hi,
    >      >
    >      > Please review a fix for doc issue.
    >      >
    >      > jira: https://bugs.openjdk.java.net/browse/JDK-8187447
    >      > webrev: http://cr.openjdk.java.net/~amenkov/8187447/webrev/
    >      >
    >      > old jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti_0.html
    >      > new jvmti.html: http://cr.openjdk.java.net/~amenkov/8187447/jvmti.html
    >      >
    >      > specdiff reports no changes:
    >      > http://cr.openjdk.java.net/~amenkov/8187447/specdiff/diff.html
    >      >
    >      > The fix:
    >      > - converts jvmti.html from HTML4 to HTML5;
    >      > - fixes all errors and almost all warnings reported by tidy and W3C HTML
    >      > Validator:
    >      >    - empty <p>;
    >      >    - unsupported attributes (align, border, width, cellpadding,
    >      > cellspacing, noshade, size, bgcolor, type);
    >      >    - <dl> without nested <dt>;
    >      >    - <a> with "name" attribute;
    >      >    - table with column with no cells beginning in it (all cells have
    >      > colspan=2);
    >      > - adds "lang" attribute for <html> (accessibility issue).
    >      >
    >      > The only remaining warning (reported by W3C HTML Validator) is
    >      >    Warning: Documents should not use about:legacy-compat, except if
    >      > generated by legacy systems that can't output the standard <!DOCTYPE
    >      > html> doctype.
    >      > This is expected as the DOCTYPE legacy string
    >      > (http://w3c.github.io/html/single-page.html#doctype-legacy-string) was
    >      > added to HTML5 standard to handle issue with XLST which cannot produce
    >      > standard doctype.
    >      >
    >      > --alex
    >      
    >      
    >
    >