84 lines · plain
1# SPDX-License-Identifier: GPL-2.0-only2 3include ../../../scripts/Makefile.include4include ../../../scripts/utilities.mak5 6INSTALL ?= install7RM ?= rm -f8RMDIR ?= rmdir --ignore-fail-on-non-empty9 10ifeq ($(V),1)11 Q =12else13 Q = @14endif15 16prefix ?= /usr/local17mandir ?= $(prefix)/man18man2dir = $(mandir)/man219man7dir = $(mandir)/man720 21SYSCALL_RST = bpf-syscall.rst22MAN2_RST = $(SYSCALL_RST)23 24HELPERS_RST = bpf-helpers.rst25MAN7_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 syscall34 35docs: $(DOCTARGETS)36syscall: man237helpers: man738man2: $(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.py45# $2 - man page section to generate the troff file46define DOCS_RULES =47$(OUTPUT)bpf-$1.rst: ../../../../include/uapi/linux/bpf.h48 $$(QUIET_GEN)../../../../scripts/bpf_doc.py $1 \49 --filename $$< > $$@50 51$(OUTPUT)%.$2: $(OUTPUT)%.rst52ifndef RST2MAN_DEP53 $$(error "rst2man not found, but required to generate man pages")54endif55 $$(QUIET_GEN)rst2man --exit-status=1 $$< > $$@.tmp56 $$(QUIET_GEN)mv $$@.tmp $$@57 58docs-clean-$1:59 $$(call QUIET_CLEAN, eBPF_$1-manpage)60 $(Q)$(RM) $$(DOC_MAN$2) $(OUTPUT)bpf-$1.rst61 62docs-install-$1: docs63 $$(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-$173endef74 75# Create the make targets to generate manual pages by name and section76$(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 man784