RFR: JDK-8180328 Bad links in footer of all javadoc-generated pages

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

RFR: JDK-8180328 Bad links in footer of all javadoc-generated pages

Magnus Ihse Bursie
There are 2 problems in the Doc.gmk file with respect to setting up the
footer option for javadoc.
1. Line 55.
JAVADOC_BASE_URL :=
http://www.oracle.com/pls/topic/lookup?ctx=javase9&id=homepage
The & should be escaped as an entity and should be & by the time the
string gets passed into javadoc.

2. Line 134
<a href="$(JAVADOC_BASE_URL)/index.html" target="_blank">Java SE \
/index.html is being added to the string being passed into javadoc. That
is wrong and causes a 404 when you click onthe link in the generated pages.

Also, with the new base URL the -Xdocrootparent does not make sense,
since you can't append a relative path to it. If a derived version of
OpenJDK wants to patch Docs.gmk to provide a different JAVADOC_BASE_URL,
they'll also have to patch it to explicitly provide a -Xdocrootparent
flag. But as OpenJDK by itself looks, the -Xdocrootparent flag is just
broken.

Bug: https://bugs.openjdk.java.net/browse/JDK-8180328
WebRev: http://cr.openjdk.java.net/~ihse/JDK-8180328-bad-docroot/webrev.01

/Magnus

Reply | Threaded
Open this post in threaded view
|

Re: RFR: JDK-8180328 Bad links in footer of all javadoc-generated pages

Erik Joelsson
Looks good.

/Erik


On 2017-05-16 12:01, Magnus Ihse Bursie wrote:

> There are 2 problems in the Doc.gmk file with respect to setting up
> the footer option for javadoc.
> 1. Line 55.
> JAVADOC_BASE_URL :=
> http://www.oracle.com/pls/topic/lookup?ctx=javase9&id=homepage
> The & should be escaped as an entity and should be &amp; by the time
> the string gets passed into javadoc.
>
> 2. Line 134
> <a href="$(JAVADOC_BASE_URL)/index.html" target="_blank">Java SE \
> /index.html is being added to the string being passed into javadoc.
> That is wrong and causes a 404 when you click onthe link in the
> generated pages.
>
> Also, with the new base URL the -Xdocrootparent does not make sense,
> since you can't append a relative path to it. If a derived version of
> OpenJDK wants to patch Docs.gmk to provide a different
> JAVADOC_BASE_URL, they'll also have to patch it to explicitly provide
> a -Xdocrootparent flag. But as OpenJDK by itself looks, the
> -Xdocrootparent flag is just broken.
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8180328
> WebRev:
> http://cr.openjdk.java.net/~ihse/JDK-8180328-bad-docroot/webrev.01
>
> /Magnus
>