Review Request: JDK-8180208 Provide a new docs bundle page
Magnus Ihse Bursie
magnus.ihse.bursie at oracle.com
Fri May 12 12:31:03 UTC 2017
Mandy,
Build changes mostly look good. I have a few requests:
1) Please rename the target docs-jdk-index instead of docs-jdk-index-html.
2) I'm glad you added a LogInfo line, however
+ $(call LogInfo, Generating docs bundle page at $@)
will print the full path to the output file, and we try to avoid it. I'd
be happy with just "$(call LogInfo, Generating docs bundle page)", since
it's unique.
3) Is this really correct?
+JDK_DOCS_INDEX_HTML := $(JAVADOC_OUTPUTDIR)/docs-index.html
I assumed the output would be index.html?
Regarding the generated page, I don't want to be bikeshedding, but I
think there's some room for improvement here... Maybe that should be
defered to a separate bug, I don't know. "Outside Java SE" just sounds
like a weird way to say "Misc" -- how can it be listed in the "Standard"
column and still be outside?
What's a "Group"? Isn't that more like "Area"? Why use "Standard"
instead of "Java SE"?
Shouldn't there be any indication that the module links are shortcuts
into the same place that the very first link "API Specification" points
to? Now it sounds like it's completely different documents.
/Magnus
On 2017-05-12 00:58, Mandy Chung wrote:
> The old docs bundle page (aka layer cake) is legacy and not maintained. In JDK 9, we replace it with a simple page listing modules by groups. This page can continuously be improved.
>
> http://cr.openjdk.java.net/~mchung/jdk9/webrevs/8180208/docs/docs-index.html
>
> This is generated by a build tool. Webrev at:
> http://cr.openjdk.java.net/~mchung/jdk9/webrevs/8180208/webrev.00/index.html
>
> The makefile generates this page in docs-index.html.
>
> Magnus - we will follow up whether you or I make the change to replace index.html.
>
> thanks
> Mandy
More information about the build-dev
mailing list