Re: [PATCH 5/5] doc lint: lint and fix missing "GIT" end sections

From: Jeff King <peff@peff.net>
Date: Mar 26, 2021, 11:04 UTC
Message-ID: <YF2/xPMvwhm+OOVz@coredump.intra.peff.net>
In-Reply-To: <patch-5.6-d4004b6a7cb-20210326T103454Z-avarab@gmail.com>

On Fri, Mar 26, 2021 at 11:36:50AM +0100, Ævar Arnfjörð Bjarmason wrote:

> Lint for and fix the three manual pages that were missing the standard
> "Part of the linkgit:git[1] suite" end section.

This is a definite improvement. Two thoughts come to mind, though:

  1. Do we need a separate script for this? Couldn't the existing linter
     script check this while it is reading all of the files (it knows
     which ones are supposed to be manpages because they are annotated
     with the --section option). That would be more efficient, and
     probably a little less code.

  2. Instead of linting, could we just be automatically sticking this
     boilerplate in as part of the build (either through some asciidoc
     magic, or even just a plain old "cat")? Even better than being
     reminded that you forgot something is making it impossible to
     forget it in the first place.

-Peff