DOC RFR (XS): 8182413: jdwp-protocol is generated without a DOCTYPE directive

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

DOC RFR (XS): 8182413: jdwp-protocol is generated without a DOCTYPE directive

serguei.spitsyn@oracle.com
Please, review a one-liner fix for the doc bug:
  https://bugs.openjdk.java.net/browse/JDK-8182413

The patch is:

diff -r bef902d8fef1 make/jdk/src/classes/build/tools/jdwpgen/RootNode.java
--- a/make/jdk/src/classes/build/tools/jdwpgen/RootNode.java Wed Nov 29 10:30:51 2017 -0800
+++ b/make/jdk/src/classes/build/tools/jdwpgen/RootNode.java Wed Nov 29 23:24:00 2017 -0800
@@ -40,6 +40,7 @@
     }
 
     void document(PrintWriter writer) {
+ writer.println("<!DOCTYPE html>");
         writer.println("<html><head><title>" + comment() + "</title></head>");
         writer.println("<body bgcolor=\"white\">");
         for (Node node : components) {


Summary: Just adding the !doctype element.

Testing:
  Built the docs target and looked at the resulting jdwp-protocol.html.


Thanks,
Serguei
Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR (XS): 8182413: jdwp-protocol is generated without a DOCTYPE directive

Alan Bateman


On 30/11/2017 07:45, [hidden email] wrote:
:
 
     void document(PrintWriter writer) {
+ writer.println("<!DOCTYPE html>");
         writer.println("<html><head><title>" + comment() + "</title></head>");
         writer.println("<body bgcolor=\"white\">");
         for (Node node : components) {

This looks okay to me. Anything else missing while you are there?

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

Re: DOC RFR (XS): 8182413: jdwp-protocol is generated without a DOCTYPE directive

serguei.spitsyn@oracle.com
Hi Alan,

Thank you for reviewing this!


On 11/30/17 00:09, Alan Bateman wrote:


On 30/11/2017 07:45, [hidden email] wrote:
:
 
     void document(PrintWriter writer) {
+ writer.println("<!DOCTYPE html>");
         writer.println("<html><head><title>" + comment() + "</title></head>");
         writer.println("<body bgcolor=\"white\">");
         for (Node node : components) {

This looks okay to me. Anything else missing while you are there?

The Copyright element is not present:
 <p><em><a href="../../legal/copyright.html">Copyright</a> © 1993, 2017, Oracle and/or its affiliates. All rights reserved.</em></p>

Not sure if we need the charset element:
  <meta charset="utf-8">

Thanks,
Serguei

-Alan

Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR (XS): 8182413: jdwp-protocol is generated without a DOCTYPE directive

serguei.spitsyn@oracle.com
On 11/30/17 00:40, [hidden email] wrote:
Hi Alan,

Thank you for reviewing this!


On 11/30/17 00:09, Alan Bateman wrote:


On 30/11/2017 07:45, [hidden email] wrote:
:
 
     void document(PrintWriter writer) {
+ writer.println("<!DOCTYPE html>");
         writer.println("<html><head><title>" + comment() + "</title></head>");
         writer.println("<body bgcolor=\"white\">");
         for (Node node : components) {

This looks okay to me. Anything else missing while you are there?

The Copyright element is not present:
 <p><em><a href="../../legal/copyright.html">Copyright</a> © 1993, 2017, Oracle and/or its affiliates. All rights reserved.</em></p>

Not sure, it is realy needed in the jdwp-protocol.html as it is an internal part
of the jdwp-spec.html which already has this Copyright line at the bottom.

Thanks,
Sergei

Not sure if we need the charset element:
  <meta charset="utf-8">

Thanks,
Serguei

-Alan