mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-01 14:44:12 +00:00
1f050e904d
Sphinx supports generating Texinfo sources and Info documentation, which can be navigated easily and is convenient to search (via the indexed nodes or anchors, for example). Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Link: https://lore.kernel.org/r/20221116190210.28407-2-maxim.cournoyer@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
64 lines
1.8 KiB
Makefile
64 lines
1.8 KiB
Makefile
# SPDX-License-Identifier: GPL-2.0
|
|
|
|
# Rules to convert a .h file to inline RST documentation
|
|
|
|
SRC_DIR=$(srctree)/Documentation/userspace-api/media
|
|
PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
|
|
UAPI = $(srctree)/include/uapi/linux
|
|
KAPI = $(srctree)/include/linux
|
|
|
|
FILES = ca.h.rst dmx.h.rst frontend.h.rst net.h.rst \
|
|
videodev2.h.rst media.h.rst cec.h.rst lirc.h.rst
|
|
|
|
TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
|
|
|
|
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)/ca.h.rst: ${UAPI}/dvb/ca.h ${PARSER} $(SRC_DIR)/ca.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/dmx.h.rst: ${UAPI}/dvb/dmx.h ${PARSER} $(SRC_DIR)/dmx.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/frontend.h.rst: ${UAPI}/dvb/frontend.h ${PARSER} $(SRC_DIR)/frontend.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PARSER} $(SRC_DIR)/net.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PARSER} $(SRC_DIR)/media.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/cec.h.rst: ${UAPI}/cec.h ${PARSER} $(SRC_DIR)/cec.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
$(BUILDDIR)/lirc.h.rst: ${UAPI}/lirc.h ${PARSER} $(SRC_DIR)/lirc.h.rst.exceptions
|
|
@$($(quiet)gen_rst)
|
|
|
|
# Media build rules
|
|
|
|
.PHONY: all html texinfo epub xml latex
|
|
|
|
all: $(IMGDOT) $(BUILDDIR) ${TARGETS}
|
|
html: all
|
|
texinfo: all
|
|
epub: all
|
|
xml: all
|
|
latex: $(IMGPDF) all
|
|
linkcheck:
|
|
|
|
clean:
|
|
-rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 2>/dev/null
|
|
|
|
$(BUILDDIR):
|
|
$(Q)mkdir -p $@
|