1 # SPDX-License-Identifier: GPL-2.0 1 # SPDX-License-Identifier: GPL-2.0
2 2
3 # Rules to convert a .h file to inline RST doc 3 # Rules to convert a .h file to inline RST documentation
4 4
5 SRC_DIR=$(srctree)/Documentation/userspace-api 5 SRC_DIR=$(srctree)/Documentation/userspace-api/media
6 PARSER = $(srctree)/Documentation/sphinx/parse 6 PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
7 UAPI = $(srctree)/include/uapi/linux 7 UAPI = $(srctree)/include/uapi/linux
8 KAPI = $(srctree)/include/linux 8 KAPI = $(srctree)/include/linux
9 9
10 FILES = ca.h.rst dmx.h.rst frontend.h.rst net. !! 10 FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
11 videodev2.h.rst media.h.rst cec.h.rst !! 11 videodev2.h.rst media.h.rst cec.h.rst lirc.h.rst
12 12
13 TARGETS := $(addprefix $(BUILDDIR)/, $(FILES)) 13 TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
14 14
15 gen_rst = \ 15 gen_rst = \
16 echo ${PARSER} $< $@ $(SRC_DIR)/$(notd 16 echo ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions; \
17 ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@ 17 ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions
18 18
19 quiet_gen_rst = echo ' PARSE $(patsubst $(s 19 quiet_gen_rst = echo ' PARSE $(patsubst $(srctree)/%,%,$<)'; \
20 ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@ 20 ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions
21 21
22 silent_gen_rst = ${gen_rst} 22 silent_gen_rst = ${gen_rst}
23 23
>> 24 $(BUILDDIR)/audio.h.rst: ${UAPI}/dvb/audio.h ${PARSER} $(SRC_DIR)/audio.h.rst.exceptions
>> 25 @$($(quiet)gen_rst)
>> 26
24 $(BUILDDIR)/ca.h.rst: ${UAPI}/dvb/ca.h ${PARSE 27 $(BUILDDIR)/ca.h.rst: ${UAPI}/dvb/ca.h ${PARSER} $(SRC_DIR)/ca.h.rst.exceptions
25 @$($(quiet)gen_rst) 28 @$($(quiet)gen_rst)
26 29
27 $(BUILDDIR)/dmx.h.rst: ${UAPI}/dvb/dmx.h ${PAR 30 $(BUILDDIR)/dmx.h.rst: ${UAPI}/dvb/dmx.h ${PARSER} $(SRC_DIR)/dmx.h.rst.exceptions
28 @$($(quiet)gen_rst) 31 @$($(quiet)gen_rst)
29 32
30 $(BUILDDIR)/frontend.h.rst: ${UAPI}/dvb/fronte 33 $(BUILDDIR)/frontend.h.rst: ${UAPI}/dvb/frontend.h ${PARSER} $(SRC_DIR)/frontend.h.rst.exceptions
31 @$($(quiet)gen_rst) 34 @$($(quiet)gen_rst)
32 35
33 $(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PAR 36 $(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PARSER} $(SRC_DIR)/net.h.rst.exceptions
34 @$($(quiet)gen_rst) 37 @$($(quiet)gen_rst)
35 38
>> 39 $(BUILDDIR)/video.h.rst: ${UAPI}/dvb/video.h ${PARSER} $(SRC_DIR)/video.h.rst.exceptions
>> 40 @$($(quiet)gen_rst)
>> 41
36 $(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2 42 $(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
37 @$($(quiet)gen_rst) 43 @$($(quiet)gen_rst)
38 44
39 $(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PAR 45 $(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PARSER} $(SRC_DIR)/media.h.rst.exceptions
40 @$($(quiet)gen_rst) 46 @$($(quiet)gen_rst)
41 47
42 $(BUILDDIR)/cec.h.rst: ${UAPI}/cec.h ${PARSER} 48 $(BUILDDIR)/cec.h.rst: ${UAPI}/cec.h ${PARSER} $(SRC_DIR)/cec.h.rst.exceptions
43 @$($(quiet)gen_rst) 49 @$($(quiet)gen_rst)
44 50
45 $(BUILDDIR)/lirc.h.rst: ${UAPI}/lirc.h ${PARSE 51 $(BUILDDIR)/lirc.h.rst: ${UAPI}/lirc.h ${PARSER} $(SRC_DIR)/lirc.h.rst.exceptions
46 @$($(quiet)gen_rst) 52 @$($(quiet)gen_rst)
47 53
48 # Media build rules 54 # Media build rules
49 55
50 .PHONY: all html texinfo epub xml latex !! 56 .PHONY: all html epub xml latex
51 57
52 all: $(IMGDOT) $(BUILDDIR) ${TARGETS} 58 all: $(IMGDOT) $(BUILDDIR) ${TARGETS}
53 html: all 59 html: all
54 texinfo: all <<
55 epub: all 60 epub: all
56 xml: all 61 xml: all
57 latex: $(IMGPDF) all 62 latex: $(IMGPDF) all
58 linkcheck: 63 linkcheck:
59 64
60 clean: 65 clean:
61 -rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 66 -rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 2>/dev/null
62 67
63 $(BUILDDIR): 68 $(BUILDDIR):
64 $(Q)mkdir -p $@ 69 $(Q)mkdir -p $@
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.