make/Javadoc.gmk
changeset 44733 6505f00be6f2
parent 44732 c43bf5c360d5
child 44734 70bbd6884287
equal deleted inserted replaced
44732:c43bf5c360d5 44733:6505f00be6f2
   341 
   341 
   342 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
   342 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
   343 # JAVASE_API_MODULEGRAPH_TARGETS.
   343 # JAVASE_API_MODULEGRAPH_TARGETS.
   344 
   344 
   345 ################################################################################
   345 ################################################################################
   346 # Copy targets
   346 # Copy JDK specs files
   347 
   347 
   348 JDWP_HTML := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
   348 # For all html documentation in $module/share/specs directories, copy it
   349 
   349 # unmodified
   350 $(eval $(call SetupCopyFiles, COPY_JDWP_HTML, \
   350 
   351     FILES := $(JDWP_HTML), \
   351 ALL_MODULES := $(call FindAllModules)
   352     DEST := $(JAVADOC_OUTPUTDIR)/platform/jpda/jdwp, \
   352 COPY_SPEC_FILTER := %.html %.gif %.jpg %.mib
       
   353 
       
   354 $(foreach m, $(ALL_MODULES), \
       
   355   $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
       
   356   $(if $(SPECS_$m), \
       
   357     $(eval $(call SetupCopyFiles, COPY_$m, \
       
   358         SRC := $(SPECS_$m), \
       
   359         FILES := $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $(SPECS_$m))), \
       
   360         DEST := $(JAVADOC_OUTPUTDIR)/specs/, \
       
   361     )) \
       
   362     $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
       
   363   ) \
       
   364 )
       
   365 
       
   366 # Special treatment for generated documentation
       
   367 
       
   368 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
       
   369 $(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \
       
   370     FILES := $(JDWP_PROTOCOL), \
       
   371     DEST := $(JAVADOC_OUTPUTDIR)/specs/jdwp, \
   353 ))
   372 ))
   354 
   373 JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL)
   355 COPY_TARGETS += $(COPY_JDWP_HTML)
   374 
   356 
   375 # Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical).
   357 # Pick jvmti.html from any jvm variant, they are all the same.
   376 JVMTI_HTML := $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
   358 JVMTI_HTML := $(firstword \
       
   359     $(wildcard $(HOTSPOT_OUTPUTDIR)/variant-*/gensrc/jvmtifiles/jvmti.html))
       
   360 
       
   361 $(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \
   377 $(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \
   362     FILES := $(JVMTI_HTML), \
   378     FILES := $(JVMTI_HTML), \
   363     DEST := $(JAVADOC_OUTPUTDIR)/platform/jvmti, \
   379     DEST := $(JAVADOC_OUTPUTDIR)/specs, \
   364 ))
   380 ))
   365 
   381 JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML)
   366 COPY_TARGETS += $(COPY_JVMTI_HTML)
       
   367 
   382 
   368 ################################################################################
   383 ################################################################################
   369 # Optional target which bundles all generated javadocs into a zip archive.
   384 # Optional target which bundles all generated javadocs into a zip archive.
   370 
   385 
   371 JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
   386 JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
   372 JAVADOC_ZIP_FILE := $(OUTPUT_ROOT)/bundles/$(JAVADOC_ZIP_NAME)
   387 JAVADOC_ZIP_FILE := $(OUTPUT_ROOT)/bundles/$(JAVADOC_ZIP_NAME)
   373 
   388 
   374 $(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \
   389 $(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \
   375   SRC := $(JAVADOC_OUTPUTDIR), \
   390     SRC := $(JAVADOC_OUTPUTDIR), \
   376   ZIP := $(JAVADOC_ZIP_FILE), \
   391     ZIP := $(JAVADOC_ZIP_FILE), \
   377   EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_MODULEGRAPH_TARGETS) \
   392     EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_MODULEGRAPH_TARGETS) \
   378       $(COPY_TARGETS), \
   393         $(JDK_SPECS_TARGETS), \
   379 ))
   394 ))
   380 
   395 
   381 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)
   396 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)
   382 
   397 
   383 ################################################################################
   398 ################################################################################
   393 
   408 
   394 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS)
   409 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS)
   395 
   410 
   396 docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
   411 docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
   397 
   412 
   398 docs-copy: $(COPY_TARGETS)
   413 docs-jdk-specs: $(JDK_SPECS_TARGETS)
   399 
   414 
   400 docs-zip: $(ZIP_TARGETS)
   415 docs-zip: $(ZIP_TARGETS)
   401 
   416 
   402 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
   417 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
   403     docs-javase-api-modulegraph docs-copy docs-zip
   418     docs-javase-api-modulegraph docs-jdk-specs docs-zip
   404 
   419 
   405 .PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
   420 .PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
   406     docs-javase-api-javadoc docs-javase-api-modulegraph docs-copy docs-zip
   421     docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs docs-zip