Makefile.docs (2239B)
1# SPDX-License-Identifier: GPL-2.0-only 2 3include ../../../scripts/Makefile.include 4include ../../../scripts/utilities.mak 5 6INSTALL ?= install 7RM ?= rm -f 8RMDIR ?= rmdir --ignore-fail-on-non-empty 9 10ifeq ($(V),1) 11 Q = 12else 13 Q = @ 14endif 15 16prefix ?= /usr/local 17mandir ?= $(prefix)/man 18man2dir = $(mandir)/man2 19man7dir = $(mandir)/man7 20 21SYSCALL_RST = bpf-syscall.rst 22MAN2_RST = $(SYSCALL_RST) 23 24HELPERS_RST = bpf-helpers.rst 25MAN7_RST = $(HELPERS_RST) 26 27_DOC_MAN2 = $(patsubst %.rst,%.2,$(MAN2_RST)) 28DOC_MAN2 = $(addprefix $(OUTPUT),$(_DOC_MAN2)) 29 30_DOC_MAN7 = $(patsubst %.rst,%.7,$(MAN7_RST)) 31DOC_MAN7 = $(addprefix $(OUTPUT),$(_DOC_MAN7)) 32 33DOCTARGETS := helpers syscall 34 35docs: $(DOCTARGETS) 36syscall: man2 37helpers: man7 38man2: $(DOC_MAN2) 39man7: $(DOC_MAN7) 40 41RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null) 42 43# Configure make rules for the man page bpf-$1.$2. 44# $1 - target for scripts/bpf_doc.py 45# $2 - man page section to generate the troff file 46define DOCS_RULES = 47$(OUTPUT)bpf-$1.rst: ../../../../include/uapi/linux/bpf.h 48 $$(QUIET_GEN)../../../../scripts/bpf_doc.py $1 \ 49 --filename $$< > $$@ 50 51$(OUTPUT)%.$2: $(OUTPUT)%.rst 52ifndef RST2MAN_DEP 53 $$(error "rst2man not found, but required to generate man pages") 54endif 55 $$(QUIET_GEN)rst2man --exit-status=1 $$< > $$@.tmp 56 $$(QUIET_GEN)mv $$@.tmp $$@ 57 58docs-clean-$1: 59 $$(call QUIET_CLEAN, eBPF_$1-manpage) 60 $(Q)$(RM) $$(DOC_MAN$2) $(OUTPUT)bpf-$1.rst 61 62docs-install-$1: docs 63 $$(call QUIET_INSTALL, eBPF_$1-manpage) 64 $(Q)$(INSTALL) -d -m 755 $(DESTDIR)$$(man$2dir) 65 $(Q)$(INSTALL) -m 644 $$(DOC_MAN$2) $(DESTDIR)$$(man$2dir) 66 67docs-uninstall-$1: 68 $$(call QUIET_UNINST, eBPF_$1-manpage) 69 $(Q)$(RM) $$(addprefix $(DESTDIR)$$(man$2dir)/,$$(_DOC_MAN$2)) 70 $(Q)$(RMDIR) $(DESTDIR)$$(man$2dir) 71 72.PHONY: $1 docs-clean-$1 docs-install-$1 docs-uninstall-$1 73endef 74 75# Create the make targets to generate manual pages by name and section 76$(eval $(call DOCS_RULES,helpers,7)) 77$(eval $(call DOCS_RULES,syscall,2)) 78 79docs-clean: $(foreach doctarget,$(DOCTARGETS), docs-clean-$(doctarget)) 80docs-install: $(foreach doctarget,$(DOCTARGETS), docs-install-$(doctarget)) 81docs-uninstall: $(foreach doctarget,$(DOCTARGETS), docs-uninstall-$(doctarget)) 82 83.PHONY: docs docs-clean docs-install docs-uninstall man2 man7