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