From:   Alejandro Colomar <alx.manpages@gmail.com>
To:     linux-man@vger.kernel.org
Cc:     Alejandro Colomar <alx@kernel.org>, groff@gnu.org
Subject: [PATCH 0/6] Moar granular linting of manual pages
Date:   Thu,  9 Mar 2023 18:58:22 +0100
Message-Id: <20230309175828.136591-1-alx@kernel.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Hi,

I'm working on getting the linters run by the Debian packaging through
override_dh_atuo_test (and hopefully other distros will do something
similar; and hopefully other projects will be interested, and will also
add some linting to their projects' manual pages, so we have better
manual pages overall, but I know I'm hoping too much with that).

One of the issues was that there are still many warnings in many pages
for most linters, so I wanted to have a large subset that would have
little to no warnings.  The only one that has no warnings at all is
'lint-man-tbl', and then there's 'lint-man-mandoc' which only has
warnings in two (external) pages.

To reduce that issue, and be able to pass more linters to the pages, I'm
splitting the 'lint-man-groff' pipeline into its elements, so I can
hopefully run most of them without warnings.  After this patch, we will
be able to run part of this pipeline in the packaging tests, since they
have no warnings, so we have some more testing.

And as a very nice side effect, we will have a complete set of
intermediate files produced by the pipeline, which allows one to inspect
any step without any manual intervention: just running the
'lint-man-groff' target will produce the entire set of intermediate
files used in the groff(1) pipeline (and also the output of col(1)).

This will help debug groff(1) when a problem arises.

Cheers,

Alex


Alejandro Colomar (6):
  lint-man.mk: make-lint-tbl: ffix
  Makefile, lint-man.mk: lint-man-groff-tbl: Split target from
    lint-man-groff
  Makefile, lint-man.mk: lint-man-groff-eqn: Split target from
    lint-man-groff
  Makefile, lint-man.mk: lint-man-groff-troff: Split target from
    lint-man-groff
  Makefile, lint-man.mk: lint-man-groff-grotty: Split target from
    lint-man-groff
  Makefile, lint-man.mk: lint-man-groff-col, lint-man-groff-grep: Split
    targets from lint-man-groff

 Makefile        |  8 ++++++-
 lib/lint-man.mk | 63 ++++++++++++++++++++++++++++++++++++++++++-------
 2 files changed, 61 insertions(+), 10 deletions(-)

-- 
2.39.2