2016-11-30 13:00:18 +03:00
# Rules to convert a .h file to inline RST documentation
docs-rst: auto-generate PDF image files
The PDF files that contain media images were actually generated
offline from their SVG or PNG source files.
Sphinx can handle PNG sources automatially. So, let's just
drop their PDF counterparts.
For SVG, however, Sphinx doesn't produce the right tags to
use the TexLive SVG support. Also, the SVG support is done via
shell execution, with is not nice.
So, while we don't have any support for SVG inside Sphinx
core or as an extension, move the logic to build them to Makefile,
producing the PDF images on runtime.
NOTE: due to the way Sphinx works, the PDF images should be
generated inside the Kernel source tree, as otherwise Sphinx
won't find it, not obeying what's specified by "O=" makefile
parameter.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-14 19:32:32 +03:00
2017-03-09 21:14:52 +03:00
SRC_DIR = $( srctree) /Documentation/media
2016-11-30 13:00:18 +03:00
PARSER = $( srctree) /Documentation/sphinx/parse-headers.pl
UAPI = $( srctree) /include/uapi/linux
KAPI = $( srctree) /include/linux
2016-07-08 15:15:03 +03:00
2016-11-30 13:00:18 +03:00
FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
videodev2.h.rst media.h.rst cec.h.rst lirc.h.rst
2016-07-07 06:21:37 +03:00
2016-11-30 13:00:18 +03:00
TARGETS := $( addprefix $( BUILDDIR) /, $( FILES) )
2016-07-07 15:29:48 +03:00
gen_rst = \
echo ${ PARSER } $< $@ $( SRC_DIR) /$( notdir $@ ) .exceptions; \
${ PARSER } $< $@ $( SRC_DIR) /$( notdir $@ ) .exceptions
quiet_gen_rst = echo ' PARSE $(patsubst $(srctree)/%,%,$<)' ; \
${ PARSER } $< $@ $( SRC_DIR) /$( notdir $@ ) .exceptions
silent_gen_rst = ${ gen_rst }
$(BUILDDIR)/audio.h.rst : ${UAPI }/dvb /audio .h ${PARSER } $( SRC_DIR ) /audio .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-07-07 06:21:37 +03:00
2016-07-07 15:29:48 +03:00
$(BUILDDIR)/ca.h.rst : ${UAPI }/dvb /ca .h ${PARSER } $( SRC_DIR ) /ca .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-07-07 13:51:03 +03:00
2016-07-07 15:29:48 +03:00
$(BUILDDIR)/dmx.h.rst : ${UAPI }/dvb /dmx .h ${PARSER } $( SRC_DIR ) /dmx .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-07-07 13:11:46 +03:00
2016-07-07 15:29:48 +03:00
$(BUILDDIR)/frontend.h.rst : ${UAPI }/dvb /frontend .h ${PARSER } $( SRC_DIR ) /frontend .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-07-07 13:42:18 +03:00
2016-07-07 15:29:48 +03:00
$(BUILDDIR)/net.h.rst : ${UAPI }/dvb /net .h ${PARSER } $( SRC_DIR ) /net .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-07-07 14:28:43 +03:00
2016-07-07 15:29:48 +03:00
$(BUILDDIR)/video.h.rst : ${UAPI }/dvb /video .h ${PARSER } $( SRC_DIR ) /video .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-07-07 14:46:49 +03:00
2016-07-08 15:15:03 +03:00
$(BUILDDIR)/videodev2.h.rst : ${UAPI }/videodev 2.h ${PARSER } $( SRC_DIR ) /videodev 2.h .rst .exceptions
2016-07-07 15:29:48 +03:00
@$( $( quiet) gen_rst)
2016-07-07 17:05:38 +03:00
2016-07-09 14:54:35 +03:00
$(BUILDDIR)/media.h.rst : ${UAPI }/media .h ${PARSER } $( SRC_DIR ) /media .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-11-02 13:25:28 +03:00
$(BUILDDIR)/cec.h.rst : ${UAPI }/cec .h ${PARSER } $( SRC_DIR ) /cec .h .rst .exceptions
2016-07-09 16:25:05 +03:00
@$( $( quiet) gen_rst)
2016-07-10 13:18:52 +03:00
$(BUILDDIR)/lirc.h.rst : ${UAPI }/lirc .h ${PARSER } $( SRC_DIR ) /lirc .h .rst .exceptions
@$( $( quiet) gen_rst)
2016-11-30 13:00:18 +03:00
# Media build rules
.PHONY : all html epub xml latex
all : $( IMGDOT ) $( BUILDDIR ) ${TARGETS }
html : all
epub : all
xml : all
latex : $( IMGPDF ) all
2017-02-15 15:16:35 +03:00
linkcheck :
2016-11-30 13:00:18 +03:00
clean :
2016-11-30 13:00:19 +03:00
-rm -f $( DOTTGT) $( IMGTGT) ${ TARGETS } 2>/dev/null
2016-11-30 13:00:18 +03:00
$(BUILDDIR) :
$( Q) mkdir -p $@