share/mk/lint/man/man.mk

   1 ########################################################################
   2 # Copyright 2021-2023, Alejandro Colomar <alx@kernel.org>
   3 # SPDX-License-Identifier: GPL-3.0-or-later
   4 ########################################################################
   5
   6
   7 ifndef MAKEFILE_LINT_MAN_MAN_INCLUDED
   8 MAKEFILE_LINT_MAN_MAN_INCLUDED := 1
   9
  10
  11 include $(MAKEFILEDIR)/cmd.mk
  12 include $(MAKEFILEDIR)/build/_.mk
  13 include $(MAKEFILEDIR)/lint/_.mk
  14 include $(MAKEFILEDIR)/lint/man/_.mk
  15 include $(MAKEFILEDIR)/src.mk
  16
  17
  18 mandoc_man_ignore_grep := $(DATAROOTDIR)/lint/mandoc/man.ignore.grep
  19
  20
  21 linters_man := mandoc tbl
  22
  23
  24 $(foreach l, $(linters_man),                                                  \
  25         $(eval _LINT_man_$(l) :=                                              \
  26                 $(patsubst $(MANDIR)/%, $(_MANDIR)/%.lint-man.$(l).touch,     \
  27                         $(NONSO_MAN))))
  28
  29
  30 $(_LINT_man_mandoc): $(_MANDIR)/%.lint-man.mandoc.touch: $(MANDIR)/% $(mandoc_man_ignore_grep) | $$(@D)/
  31         $(info LINT (mandoc)    $@)
  32         ! ($(MANDOC) -man $(MANDOCFLAGS) $< 2>&1 \
  33            | $(GREP) -v -f '$(mandoc_man_ignore_grep)' \
  34            ||:; \
  35         ) \
  36         | $(GREP) ^ >&2
  37         touch $@
  38
  39 $(_LINT_man_tbl): $(_MANDIR)/%.lint-man.tbl.touch: $(MANDIR)/% | $$(@D)/
  40         $(info LINT (tbl comment)       $@)
  41         if $(GREP) -q '^\.TS$$' $< && ! $(HEAD) -n1 $< | $(GREP) -q '\\" t$$'; \
  42         then \
  43                 >&2 $(ECHO) "$<:1: missing '\\\" t' comment:"; \
  44                 >&2 $(HEAD) -n1 <$<; \
  45                 exit 1; \
  46         fi
  47         if $(HEAD) -n1 $< | $(GREP) -q '\\" t$$' && ! $(GREP) -q '^\.TS$$' $<; \
  48         then \
  49                 >&2 $(ECHO) "$<:1: spurious '\\\" t' comment:"; \
  50                 >&2 $(HEAD) -n1 <$<; \
  51                 exit 1; \
  52         fi
  53         if $(TAIL) -n+2 <$< | $(GREP) -q '\\" t$$'; \
  54         then \
  55                 >&2 $(ECHO) "$<: spurious '\\\" t' not in first line:"; \
  56                 >&2 $(GREP) -n '\\" t$$' $< /dev/null; \
  57                 exit 1; \
  58         fi
  59         touch $@
  60
  61
  62 $(foreach l, $(linters_man),                                                  \
  63         $(eval .PHONY: lint-man-$(l)))
  64 $(foreach l, $(linters_man),                                                  \
  65         $(eval lint-man-$(l): $(_LINT_man_$(l));))
  66 .PHONY: lint-man
  67 lint-man: $(foreach l, $(linters_man), lint-man-$(l));
  68
  69
  70 endif  # include guard