Documentation: add top level 'make help' output for Sphinx
authorJani Nikula <jani.nikula@intel.com>
Wed, 22 Jun 2016 12:41:48 +0000 (15:41 +0300)
committerJani Nikula <jani.nikula@intel.com>
Thu, 23 Jun 2016 12:11:51 +0000 (15:11 +0300)
While there's slight overlap with the DocBook help now, this can stay
intact when the DocBook help goes away.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Documentation/DocBook/Makefile
Documentation/Makefile.sphinx
Makefile

index e0c7e1e..496d429 100644 (file)
@@ -218,7 +218,7 @@ silent_gen_xml = :
 ###
 # Help targets as used by the top-level makefile
 dochelp:
-       @echo  ' Linux kernel internal documentation in different formats:'
+       @echo  ' Linux kernel internal documentation in different formats (DocBook):'
        @echo  '  htmldocs        - HTML'
        @echo  '  pdfdocs         - PDF'
        @echo  '  psdocs          - Postscript'
@@ -227,7 +227,7 @@ dochelp:
        @echo  '  installmandocs  - install man pages generated by mandocs'
        @echo  '  cleandocs       - clean all generated DocBook files'
        @echo
-       @echo  'make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
+       @echo  '  make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
        @echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'
 
 
index addf323..810c11f 100644 (file)
@@ -60,4 +60,12 @@ installmandocs:
 cleandocs:
        $(Q)rm -rf $(BUILDDIR)
 
+dochelp:
+       @echo  ' Linux kernel internal documentation in different formats (Sphinx):'
+       @echo  '  htmldocs        - HTML'
+       @echo  '  pdfdocs         - PDF'
+       @echo  '  epubdocs        - EPUB'
+       @echo  '  xmldocs         - XML'
+       @echo  '  cleandocs       - clean all generated files'
+
 endif # HAVE_SPHINX
index 8908a51..f7f393c 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1364,6 +1364,8 @@ help:
        @$(MAKE) $(build)=$(package-dir) help
        @echo  ''
        @echo  'Documentation targets:'
+       @$(MAKE) -f $(srctree)/Documentation/Makefile.sphinx dochelp
+       @echo  ''
        @$(MAKE) -f $(srctree)/Documentation/DocBook/Makefile dochelp
        @echo  ''
        @echo  'Architecture specific targets ($(SRCARCH)):'