Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bdf107d8 authored by Jani Nikula's avatar Jani Nikula Committed by Jonathan Corbet
Browse files

DocBook: use DOCBOOKS="" to ignore DocBooks instead of IGNORE_DOCBOOKS=1 



Instead of a separate ignore flag, use the obvious DOCBOOKS="" to ignore
all DocBook files. This is also in line with the Sphinx build being
ignored if a non-empty DOCBOOKS make variable is specified on the make
command line.

This replaces the IGNORE_DOCBOOKS introduced in

commit 54721886
Author: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date:   Sat Jul 9 13:12:45 2016 -0300

    doc-rst: add an option to ignore DocBooks when generating docs

and aligns with

commit 6387872c
Author: Jani Nikula <jani.nikula@intel.com>
Date:   Fri Jul 1 15:24:44 2016 +0300

    Documentation/sphinx: skip build if user requested specific DOCBOOKS

Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
Tested-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 09c3bcce

Documentation/DocBook/Makefile

+10 −16
Original line number Original line Diff line number Diff line
@@ -6,8 +6,6 @@ 
# To add a new book the only step required is to add the book to the

# To add a new book the only step required is to add the book to the

# list of DOCBOOKS.

# list of DOCBOOKS.





ifeq ($(IGNORE_DOCBOOKS),)



DOCBOOKS := z8530book.xml device-drivers.xml \

DOCBOOKS := z8530book.xml device-drivers.xml \

	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \

	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \

	    writing_usb_driver.xml networking.xml \

	    writing_usb_driver.xml networking.xml \
@@ -19,6 +17,14 @@ DOCBOOKS := z8530book.xml device-drivers.xml \ 
	    tracepoint.xml gpu.xml media_api.xml w1.xml \

	    tracepoint.xml gpu.xml media_api.xml w1.xml \

	    writing_musb_glue_layer.xml crypto-API.xml iio.xml

	    writing_musb_glue_layer.xml crypto-API.xml iio.xml





ifeq ($(DOCBOOKS),)



# Skip DocBook build if the user explicitly requested no DOCBOOKS.

.DEFAULT:

	@echo "  SKIP    DocBook $@ target (DOCBOOKS=\"\" specified)."



else



include Documentation/DocBook/media/Makefile

include Documentation/DocBook/media/Makefile





###

###
@@ -217,19 +223,7 @@ silent_gen_xml = : 
	       -e "s/>/\\&gt;/g";     \

	       -e "s/>/\\&gt;/g";     \

	   echo "</programlisting>")  > $@

	   echo "</programlisting>")  > $@





else

endif # DOCBOOKS=""



# Needed, due to cleanmediadocs

include Documentation/DocBook/media/Makefile



htmldocs:

pdfdocs:

psdocs:

xmldocs:

installmandocs:



endif # IGNORE_DOCBOOKS







###

###

# Help targets as used by the top-level makefile

# Help targets as used by the top-level makefile
@@ -246,7 +240,7 @@ dochelp: 
	@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)'

	@echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'

	@echo

	@echo

	@echo  "  make IGNORE_DOCBOOKS=1 [target] Don't generate docs from Docbook"

	@echo  "  make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"

	@echo  '     This is useful to generate only the ReST docs (Sphinx)'

	@echo  '     This is useful to generate only the ReST docs (Sphinx)'