SWAMPy

✎ CARVE FLESH

EDITING: Makefile.docs

# SPDX-License-Identifier: GPL-2.0-only

include ../../../scripts/Makefile.include
include ../../../scripts/utilities.mak

INSTALL ?= install
RM ?= rm -f
RMDIR ?= rmdir --ignore-fail-on-non-empty

ifeq ($(V),1)
  Q =
else
  Q = @
endif

prefix ?= /usr/local
mandir ?= $(prefix)/man
man2dir = $(mandir)/man2
man7dir = $(mandir)/man7

SYSCALL_RST = bpf-syscall.rst
MAN2_RST = $(SYSCALL_RST)

HELPERS_RST = bpf-helpers.rst
MAN7_RST = $(HELPERS_RST)

_DOC_MAN2 = $(patsubst %.rst,%.2,$(MAN2_RST))
DOC_MAN2 = $(addprefix $(OUTPUT),$(_DOC_MAN2))

_DOC_MAN7 = $(patsubst %.rst,%.7,$(MAN7_RST))
DOC_MAN7 = $(addprefix $(OUTPUT),$(_DOC_MAN7))

DOCTARGETS := helpers syscall

docs: $(DOCTARGETS)
syscall: man2
helpers: man7
man2: $(DOC_MAN2)
man7: $(DOC_MAN7)

RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null)

# Configure make rules for the man page bpf-$1.$2.
# $1 - target for scripts/bpf_doc.py
# $2 - man page section to generate the troff file
define DOCS_RULES =
$(OUTPUT)bpf-$1.rst: ../../../../include/uapi/linux/bpf.h
	$$(QUIET_GEN)../../../../scripts/bpf_doc.py $1 \
		--filename $$< > $$@

$(OUTPUT)%.$2: $(OUTPUT)%.rst
ifndef RST2MAN_DEP
	$$(error "rst2man not found, but required to generate man pages")
endif
	$$(QUIET_GEN)rst2man --exit-status=1 $$< > $$@.tmp
	$$(QUIET_GEN)mv $$@.tmp $$@

docs-clean-$1:
	$$(call QUIET_CLEAN, eBPF_$1-manpage)
	$(Q)$(RM) $$(DOC_MAN$2) $(OUTPUT)bpf-$1.rst

docs-install-$1: docs
	$$(call QUIET_INSTALL, eBPF_$1-manpage)
	$(Q)$(INSTALL) -d -m 755 $(DESTDIR)$$(man$2dir)
	$(Q)$(INSTALL) -m 644 $$(DOC_MAN$2) $(DESTDIR)$$(man$2dir)

docs-uninstall-$1:
	$$(call QUIET_UNINST, eBPF_$1-manpage)
	$(Q)$(RM) $$(addprefix $(DESTDIR)$$(man$2dir)/,$$(_DOC_MAN$2))
	$(Q)$(RMDIR) $(DESTDIR)$$(man$2dir)

.PHONY: $1 docs-clean-$1 docs-install-$1 docs-uninstall-$1
endef

# Create the make targets to generate manual pages by name and section
$(eval $(call DOCS_RULES,helpers,7))
$(eval $(call DOCS_RULES,syscall,2))

docs-clean: $(foreach doctarget,$(DOCTARGETS), docs-clean-$(doctarget))
docs-install: $(foreach doctarget,$(DOCTARGETS), docs-install-$(doctarget))
docs-uninstall: $(foreach doctarget,$(DOCTARGETS), docs-uninstall-$(doctarget))

.PHONY: docs docs-clean docs-install docs-uninstall man2 man7

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 benchs/	DIR	—	2026-03-10 17:25
📁 bpf_testmod/	DIR	—	2026-03-10 17:25
📄 ima_setup.sh	SH	3.3 KB	2024-03-10 20:38	EDIT
📄 Makefile	?	29.3 KB	2025-11-21 22:00	EDIT
📄 Makefile.docs	DOCS	2.2 KB	2024-03-10 20:38	EDIT
📄 test_bpftool.sh	SH	415 B	2024-03-10 20:38	EDIT
📄 test_bpftool_build.sh	SH	3.9 KB	2024-03-10 20:38	EDIT
📄 test_bpftool_metadata.sh	SH	1.6 KB	2024-03-10 20:38	EDIT
📄 test_doc_build.sh	SH	638 B	2024-03-10 20:38	EDIT
📄 test_flow_dissector.sh	SH	5.5 KB	2024-03-10 20:38	EDIT
📄 test_ftrace.sh	SH	786 B	2024-03-10 20:38	EDIT
📄 test_kmod.sh	SH	1.5 KB	2024-03-10 20:38	EDIT
📄 test_lirc_mode2.sh	SH	764 B	2024-03-10 20:38	EDIT
📄 test_lwt_ip_encap.sh	SH	14.6 KB	2024-03-10 20:38	EDIT
📄 test_lwt_seg6local.sh	SH	6.1 KB	2024-03-10 20:38	EDIT
📄 test_skb_cgroup_id.sh	SH	1.3 KB	2024-03-10 20:38	EDIT
📄 test_sock_addr.sh	SH	1.1 KB	2024-03-10 20:38	EDIT
📄 test_tc_edt.sh	SH	2.7 KB	2024-03-10 20:38	EDIT
📄 test_tc_tunnel.sh	SH	7.8 KB	2025-11-21 22:00	EDIT
📄 test_tcp_check_syncookie.sh	SH	1.7 KB	2024-03-10 20:38	EDIT
📄 test_tunnel.sh	SH	14.3 KB	2024-03-10 20:38	EDIT
📄 test_xdp_features.sh	SH	2.5 KB	2024-03-10 20:38	EDIT
📄 test_xdp_meta.sh	SH	1.5 KB	2024-03-10 20:38	EDIT
📄 test_xdp_redirect.sh	SH	1.8 KB	2024-03-10 20:38	EDIT
📄 test_xdp_redirect_multi.sh	SH	6.2 KB	2024-03-10 20:38	EDIT
📄 test_xdp_veth.sh	SH	3.2 KB	2024-03-10 20:38	EDIT
📄 test_xdp_vlan.sh	SH	5.9 KB	2024-03-10 20:38	EDIT
📄 test_xdp_vlan_mode_generic.sh	SH	186 B	2024-03-10 20:38	EDIT
📄 test_xdp_vlan_mode_native.sh	SH	180 B	2024-03-10 20:38	EDIT
📄 test_xdping.sh	SH	2.1 KB	2024-03-10 20:38	EDIT
📄 test_xsk.sh	SH	5.3 KB	2024-03-10 20:38	EDIT
📄 verify_sig_setup.sh	SH	2.7 KB	2024-03-10 20:38	EDIT
📄 vmtest.sh	SH	9.9 KB	2024-03-10 20:38	EDIT
📄 with_addr.sh	SH	1.3 KB	2024-03-10 20:38	EDIT
📄 with_tunnels.sh	SH	693 B	2024-03-10 20:38	EDIT
📄 xsk_prereqs.sh	SH	1.5 KB	2024-03-10 20:38	EDIT