blob: 36166952d555fbc5444e6c2c9c11c081c81df2f1 [file] [log] [blame]
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -02001# Rules to convert a .h file to inline RST documentation
Mauro Carvalho Chehab15a04d42016-11-14 14:32:32 -02002
Mauro Carvalho Chehab8fa1bb52017-03-09 15:14:52 -03003SRC_DIR=$(srctree)/Documentation/media
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -02004PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
5UAPI = $(srctree)/include/uapi/linux
6KAPI = $(srctree)/include/linux
Mauro Carvalho Chehab15a04d42016-11-14 14:32:32 -02007
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -02008FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
9 videodev2.h.rst media.h.rst cec.h.rst lirc.h.rst
Mauro Carvalho Chehab60c28202016-07-08 11:40:06 -030010
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -020011TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
Mauro Carvalho Chehab60c28202016-07-08 11:40:06 -030012
13gen_rst = \
14 echo ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions; \
15 ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions
16
17quiet_gen_rst = echo ' PARSE $(patsubst $(srctree)/%,%,$<)'; \
18 ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions
19
20silent_gen_rst = ${gen_rst}
21
22$(BUILDDIR)/audio.h.rst: ${UAPI}/dvb/audio.h ${PARSER} $(SRC_DIR)/audio.h.rst.exceptions
23 @$($(quiet)gen_rst)
24
25$(BUILDDIR)/ca.h.rst: ${UAPI}/dvb/ca.h ${PARSER} $(SRC_DIR)/ca.h.rst.exceptions
26 @$($(quiet)gen_rst)
27
28$(BUILDDIR)/dmx.h.rst: ${UAPI}/dvb/dmx.h ${PARSER} $(SRC_DIR)/dmx.h.rst.exceptions
29 @$($(quiet)gen_rst)
30
31$(BUILDDIR)/frontend.h.rst: ${UAPI}/dvb/frontend.h ${PARSER} $(SRC_DIR)/frontend.h.rst.exceptions
32 @$($(quiet)gen_rst)
33
34$(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PARSER} $(SRC_DIR)/net.h.rst.exceptions
35 @$($(quiet)gen_rst)
36
37$(BUILDDIR)/video.h.rst: ${UAPI}/dvb/video.h ${PARSER} $(SRC_DIR)/video.h.rst.exceptions
38 @$($(quiet)gen_rst)
39
40$(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
41 @$($(quiet)gen_rst)
42
Mauro Carvalho Chehabd2c68152016-07-09 08:54:35 -030043$(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PARSER} $(SRC_DIR)/media.h.rst.exceptions
44 @$($(quiet)gen_rst)
45
Hans Verkuil0dbaceb2016-11-02 08:25:28 -020046$(BUILDDIR)/cec.h.rst: ${UAPI}/cec.h ${PARSER} $(SRC_DIR)/cec.h.rst.exceptions
Mauro Carvalho Chehab96f69e02016-07-09 10:25:05 -030047 @$($(quiet)gen_rst)
48
Mauro Carvalho Chehab68cd5e02016-07-10 07:18:52 -030049$(BUILDDIR)/lirc.h.rst: ${UAPI}/lirc.h ${PARSER} $(SRC_DIR)/lirc.h.rst.exceptions
50 @$($(quiet)gen_rst)
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -020051
52# Media build rules
53
54.PHONY: all html epub xml latex
55
56all: $(IMGDOT) $(BUILDDIR) ${TARGETS}
57html: all
58epub: all
59xml: all
60latex: $(IMGPDF) all
Rémy Léone62924fd2017-02-15 13:16:35 +010061linkcheck:
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -020062
63clean:
Mauro Carvalho Chehab293fbd42016-11-30 08:00:19 -020064 -rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 2>/dev/null
Mauro Carvalho Chehabbf5bfe82016-11-30 08:00:18 -020065
66$(BUILDDIR):
67 $(Q)mkdir -p $@