diff options
author | Jani Nikula <jani.nikula@intel.com> | 2016-06-22 08:41:48 -0400 |
---|---|---|
committer | Jani Nikula <jani.nikula@intel.com> | 2016-06-23 08:11:51 -0400 |
commit | ebc88ef05c825024a5d95285459b8c842c095c0f (patch) | |
tree | f488b1bf47eb177d9730b3308ef36e1bfa6de2fa | |
parent | 0cea220cf739c8b64d1d9ad75f4817621d3dc897 (diff) |
Documentation: add top level 'make help' output for Sphinx
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>
-rw-r--r-- | Documentation/DocBook/Makefile | 4 | ||||
-rw-r--r-- | Documentation/Makefile.sphinx | 8 | ||||
-rw-r--r-- | Makefile | 2 |
3 files changed, 12 insertions, 2 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index e0c7e1e0590b..496d4295ec38 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -218,7 +218,7 @@ silent_gen_xml = : | |||
218 | ### | 218 | ### |
219 | # Help targets as used by the top-level makefile | 219 | # Help targets as used by the top-level makefile |
220 | dochelp: | 220 | dochelp: |
221 | @echo ' Linux kernel internal documentation in different formats:' | 221 | @echo ' Linux kernel internal documentation in different formats (DocBook):' |
222 | @echo ' htmldocs - HTML' | 222 | @echo ' htmldocs - HTML' |
223 | @echo ' pdfdocs - PDF' | 223 | @echo ' pdfdocs - PDF' |
224 | @echo ' psdocs - Postscript' | 224 | @echo ' psdocs - Postscript' |
@@ -227,7 +227,7 @@ dochelp: | |||
227 | @echo ' installmandocs - install man pages generated by mandocs' | 227 | @echo ' installmandocs - install man pages generated by mandocs' |
228 | @echo ' cleandocs - clean all generated DocBook files' | 228 | @echo ' cleandocs - clean all generated DocBook files' |
229 | @echo | 229 | @echo |
230 | @echo 'make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml' | 230 | @echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml' |
231 | @echo ' valid values for DOCBOOKS are: $(DOCBOOKS)' | 231 | @echo ' valid values for DOCBOOKS are: $(DOCBOOKS)' |
232 | 232 | ||
233 | 233 | ||
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx index addf32309bc3..810c11f0d37f 100644 --- a/Documentation/Makefile.sphinx +++ b/Documentation/Makefile.sphinx | |||
@@ -60,4 +60,12 @@ installmandocs: | |||
60 | cleandocs: | 60 | cleandocs: |
61 | $(Q)rm -rf $(BUILDDIR) | 61 | $(Q)rm -rf $(BUILDDIR) |
62 | 62 | ||
63 | dochelp: | ||
64 | @echo ' Linux kernel internal documentation in different formats (Sphinx):' | ||
65 | @echo ' htmldocs - HTML' | ||
66 | @echo ' pdfdocs - PDF' | ||
67 | @echo ' epubdocs - EPUB' | ||
68 | @echo ' xmldocs - XML' | ||
69 | @echo ' cleandocs - clean all generated files' | ||
70 | |||
63 | endif # HAVE_SPHINX | 71 | endif # HAVE_SPHINX |
@@ -1364,6 +1364,8 @@ help: | |||
1364 | @$(MAKE) $(build)=$(package-dir) help | 1364 | @$(MAKE) $(build)=$(package-dir) help |
1365 | @echo '' | 1365 | @echo '' |
1366 | @echo 'Documentation targets:' | 1366 | @echo 'Documentation targets:' |
1367 | @$(MAKE) -f $(srctree)/Documentation/Makefile.sphinx dochelp | ||
1368 | @echo '' | ||
1367 | @$(MAKE) -f $(srctree)/Documentation/DocBook/Makefile dochelp | 1369 | @$(MAKE) -f $(srctree)/Documentation/DocBook/Makefile dochelp |
1368 | @echo '' | 1370 | @echo '' |
1369 | @echo 'Architecture specific targets ($(SRCARCH)):' | 1371 | @echo 'Architecture specific targets ($(SRCARCH)):' |