mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2025-01-17 02:36:21 +00:00
f7b6854364
The rST manual pages for bpftool would use a mix of tabs and spaces for indentation. While this is the norm in C code, this is rather unusual for rST documents, and over time we've seen many contributors use a wrong level of indentation for documentation update. Let's fix bpftool's indentation in docs once and for all: - Let's use spaces, that are more common in rST files. - Remove one level of indentation for the synopsis, the command description, and the "see also" section. As a result, all sections start with the same indentation level in the generated man page. - Rewrap the paragraphs after the changes. There is no content change in this patch, only indentation and rewrapping changes. The wrapping in the generated source files for the manual pages is changed, but the pages displayed with "man" remain the same, apart from the adjusted indentation level on relevant sections. [ Quentin: rebased on bpf-next, removed indent level for command description and options, updated synopsis, command summary, and "see also" sections. ] Signed-off-by: Rameez Rehman <rameezrehman408@hotmail.com> Signed-off-by: Quentin Monnet <qmo@kernel.org> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net> Link: https://lore.kernel.org/bpf/20240331200346.29118-2-qmo@kernel.org
61 lines
1.4 KiB
Makefile
61 lines
1.4 KiB
Makefile
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
|
include ../../../scripts/Makefile.include
|
|
|
|
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
|
|
man8dir = $(mandir)/man8
|
|
|
|
MAN8_RST = $(wildcard bpftool*.rst)
|
|
|
|
_DOC_MAN8 = $(patsubst %.rst,%.8,$(MAN8_RST))
|
|
DOC_MAN8 = $(addprefix $(OUTPUT),$(_DOC_MAN8))
|
|
|
|
man: man8
|
|
man8: $(DOC_MAN8)
|
|
|
|
RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null)
|
|
RST2MAN_OPTS += --verbose --strip-comments
|
|
|
|
list_pages = $(sort $(basename $(filter-out $(1),$(MAN8_RST))))
|
|
see_also = $(subst " ",, \
|
|
"\n" \
|
|
"SEE ALSO\n" \
|
|
"========\n" \
|
|
"**bpf**\ (2),\n" \
|
|
"**bpf-helpers**\\ (7)" \
|
|
$(foreach page,$(call list_pages,$(1)),",\n**$(page)**\\ (8)") \
|
|
"\n")
|
|
|
|
$(OUTPUT)%.8: %.rst
|
|
ifndef RST2MAN_DEP
|
|
$(error "rst2man not found, but required to generate man pages")
|
|
endif
|
|
$(QUIET_GEN)( cat $< ; printf "%b" $(call see_also,$<) ) | rst2man $(RST2MAN_OPTS) > $@
|
|
|
|
clean:
|
|
$(call QUIET_CLEAN, Documentation)
|
|
$(Q)$(RM) $(DOC_MAN8)
|
|
|
|
install: man
|
|
$(call QUIET_INSTALL, Documentation-man)
|
|
$(Q)$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
|
|
$(Q)$(INSTALL) -m 644 $(DOC_MAN8) $(DESTDIR)$(man8dir)
|
|
|
|
uninstall:
|
|
$(call QUIET_UNINST, Documentation-man)
|
|
$(Q)$(RM) $(addprefix $(DESTDIR)$(man8dir)/,$(_DOC_MAN8))
|
|
$(Q)$(RMDIR) $(DESTDIR)$(man8dir)
|
|
|
|
.PHONY: man man8 clean install uninstall
|
|
.DEFAULT_GOAL := man
|