make/Docs.gmk
branchihse-manpages-branch
changeset 56891 78ed9c424877
parent 51575 76072a077ee1
child 56950 55725429863a
equal deleted inserted replaced
56890:bedeb1e73c99 56891:78ed9c424877
    57 
    57 
    58 # On top of the sources that was used to compile the JDK, we need some
    58 # On top of the sources that was used to compile the JDK, we need some
    59 # extra java.rmi sources that are used just for javadoc.
    59 # extra java.rmi sources that are used just for javadoc.
    60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
    60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
    61     $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
    61     $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
       
    62 
       
    63 # Should we enable man pages? Allow custom to overwrite.
       
    64 ENABLE_MAN_PAGES ?= true
    62 
    65 
    63 # URLs
    66 # URLs
    64 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase$(VERSION_NUMBER)&id=homepage
    67 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase$(VERSION_NUMBER)&id=homepage
    65 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
    68 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
    66 COPYRIGHT_URL := {@docroot}/../legal/copyright.html
    69 COPYRIGHT_URL := {@docroot}/../legal/copyright.html
   551         )) \
   554         )) \
   552         $(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \
   555         $(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \
   553       ) \
   556       ) \
   554     ) \
   557     ) \
   555   )
   558   )
       
   559 
       
   560   ifeq ($(ENABLE_MAN_PAGES), true)
       
   561     # We assume all man pages should reside in section 1
       
   562 
       
   563     # Copy man pages already in troff format
       
   564     $(foreach m, $(ALL_MODULES), \
       
   565       $(eval MAN_$m := $(call FindModuleManDirs, $m)) \
       
   566       $(foreach d, $(MAN_$m), \
       
   567         $(if $(filter %.1, $(call CacheFind, $d)), \
       
   568           $(eval $(call SetupCopyFiles, COPY_MAN_$m, \
       
   569               SRC := $d, \
       
   570               FILES := $(filter %.1, $(call CacheFind, $d)), \
       
   571               DEST := $(JAVADOC_OUTPUTDIR)/man/man1, \
       
   572           )) \
       
   573           $(eval JDK_SPECS_TARGETS += $(COPY_MAN_$m)) \
       
   574         ) \
       
   575       ) \
       
   576     )
       
   577 
       
   578     # Generate man pages from markdown
       
   579     $(foreach m, $(ALL_MODULES), \
       
   580       $(eval MAN_$m := $(call FindModuleManDirs, $m)) \
       
   581       $(foreach d, $(MAN_$m), \
       
   582         $(if $(filter %.md, $(call CacheFind, $d)), \
       
   583           $(eval $(call SetupProcessMarkdown, CONVERT_MARKDOWN_MAN_$m_$d, \
       
   584               SRC := $d, \
       
   585               FILES := $(filter %.md, $(call CacheFind, $d)), \
       
   586               DEST := $(JAVADOC_OUTPUTDIR)/man/man1, \
       
   587               FORMAT := man, \
       
   588               FILE_EXT := .1, \
       
   589           )) \
       
   590         ) \
       
   591         $(eval JDK_SPECS_TARGETS += $(CONVERT_MARKDOWN_MAN_$m_$d)) \
       
   592       ) \
       
   593     )
       
   594   endif
   556 endif
   595 endif
   557 
   596 
   558 # Special treatment for generated documentation
   597 # Special treatment for generated documentation
   559 
   598 
   560 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
   599 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html