Extensionality Improvement in Main.gmk & Docs.gmk to generate docs

[Archana Nogriya]

Thanks Erik agree with you, the changes from JDK11 you mentioned is very 
similar to what I propose and that will serve the purpose.

However the patch for the second part is related to locating jvmti.html, 
VM's like openj9 has it's own html specs file in different location hence 
we need extension to set it appropriately. 

#  Get jvmti.html from the main jvm variant (all variants' jvmti.html are 
identical). 
-JVMTI_HTML := 
$(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
-$(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \ 
-    FILES := $(JVMTI_HTML), \ 
-    DEST := $(DOCS_OUTPUTDIR)/specs, \ 
-)) 
-JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML) 
+JVMTI_HTML ?= 
$(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
+$(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \ 
+    FILES := $(JVMTI_HTML), \ 
+    DEST := $(DOCS_OUTPUTDIR)/specs, \ 
+)) 
+JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML) 

Thanks and Regards
Archana Nogriya 




From:   Erik Joelsson <erik.joelsson at oracle.com>
To:     Archana Nogriya <archana.nogriya at uk.ibm.com>
Cc:     build-dev at openjdk.java.net, David Holmes <david.holmes at oracle.com>
Date:   27/04/2018 18:05
Subject:        Re: Extensionality Improvement in Main.gmk & Docs.gmk to 
generate docs



Looking at this again, the first part, in Main.gmk, has already been 
addressed in https://bugs.openjdk.java.net/browse/JDK-8198425. The patch 
for the second part looks weird. The only real change I can see is the ?= 
for the jvmti.html file. The rest looks like there is no difference (and I 
cannot think of any change needed there either).
/Erik

On 2018-04-27 02:12, Archana Nogriya wrote:
Thanks Erik, 

It will be great if you can sponsor for this contribution please.   


Thanks and Regards
Archana Nogriya 
IBM Java Runtime, Open Java Developer
IBM Hursley
Tel: Internal - 247073, External - +44 (0) 1962 81 7073
Office Mobile: 07500095480
Email: archana.nogriya at uk.ibm.com 



From:        Erik Joelsson <erik.joelsson at oracle.com> 
To:        Archana Nogriya <archana.nogriya at uk.ibm.com>, 
build-dev at openjdk.java.net 
Cc:        David Holmes <david.holmes at oracle.com> 
Date:        26/04/2018 17:15 
Subject:        Re: Extensionality Improvement in Main.gmk & Docs.gmk to 
generate docs 



Looks reasonable. 
/Erik 

On 2018-04-26 04:00, Archana Nogriya wrote: 
If we have a conditional variable to set "
hotspot-$(JVM_VARIANT_MAIN)-gensrc" target then this can give way to 
alternate VMs like eclipse openj9 to extend that to set it appropriately. 

diff --git a/make/Main.gmk b/make/Main.gmk 
index 731e9c9934..444a835cb4 100644 
--- a/make/Main.gmk 
+++ b/make/Main.gmk 
@@ -830,7 +830,8 @@ else 
   docs-reference-api-modulegraph: exploded-image buildtools-modules 
  
   # The gensrc steps for hotspot and jdk.jdi create html spec files. 
-  docs-jdk-specs: jdk.jdi-gensrc \ 
+  JVM_DOCS_SPEC_TARGET ?= hotspot-$(JVM_VARIANT_MAIN)-gensrc 
+  docs-jdk-specs: $(JVM_DOCS_SPEC_TARGET) jdk.jdi-gensrc \ 
       docs-jdk-index 


###################################################################################### 


diff --git a/make/Docs.gmk b/make/Docs.gmk 
index 644ffbf74a..73ffb8ebd2 100644 
--- a/make/Docs.gmk 
+++ b/make/Docs.gmk 
@@ -561,12 +561,12 @@ $(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \ 
 JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL) 
  
#  Get jvmti.html from the main jvm variant (all variants' jvmti.html are 
identical). 
-JVMTI_HTML := 
$(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
-$(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \ 
-    FILES := $(JVMTI_HTML), \ 
-    DEST := $(DOCS_OUTPUTDIR)/specs, \ 
-)) 
-JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML) 
+JVMTI_HTML ?= 
$(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
+$(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \ 
+    FILES := $(JVMTI_HTML), \ 
+    DEST := $(DOCS_OUTPUTDIR)/specs, \ 
+)) 
+JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML) 
  
Note: This proposal has been tested in local.

Thanks and Regards
Archana Nogriya 
IBM Java Runtime, Open Java Developer
IBM Hursley
Tel: Internal - 247073, External - +44 (0) 1962 81 7073
Office Mobile: 07500095480
Email: archana.nogriya at uk.ibm.com 

Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number 
741598. 
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU 





Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number 
741598. 
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU




Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number 
741598. 
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU