92426820f7
If rst2man is not available on the system, running `make doc` from the
bpftool directory fails with an error message. However, it creates empty
manual pages (.8 files in this case). A subsequent call to `make
doc-install` would then succeed and install those empty man pages on the
system.
To prevent this, raise a Makefile error and exit immediately if rst2man
is not available before generating the pages from the rst documentation.
Fixes: ff69c21a85 ("tools: bpftool: add documentation")
Reported-by: Jason van Aaardt <jason.vanaardt@netronome.com>
Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Reviewed-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
50 lines
1.0 KiB
Makefile
50 lines
1.0 KiB
Makefile
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
|
|
man8dir = $(mandir)/man8
|
|
|
|
MAN8_RST = $(wildcard *.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)
|
|
|
|
$(OUTPUT)%.8: %.rst
|
|
ifndef RST2MAN_DEP
|
|
$(error "rst2man not found, but required to generate man pages")
|
|
endif
|
|
$(QUIET_GEN)rst2man $< > $@
|
|
|
|
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
|