From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_PASS, SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by dcvr.yhbt.net (Postfix) with ESMTP id A8D8D1F9FC for ; Fri, 26 Mar 2021 11:05:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229622AbhCZLEx (ORCPT ); Fri, 26 Mar 2021 07:04:53 -0400 Received: from cloud.peff.net ([104.130.231.41]:49778 "EHLO cloud.peff.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229589AbhCZLEh (ORCPT ); Fri, 26 Mar 2021 07:04:37 -0400 Received: (qmail 32175 invoked by uid 109); 26 Mar 2021 11:04:37 -0000 Received: from Unknown (HELO peff.net) (10.0.1.2) by cloud.peff.net (qpsmtpd/0.94) with ESMTP; Fri, 26 Mar 2021 11:04:37 +0000 Authentication-Results: cloud.peff.net; auth=none Received: (qmail 4704 invoked by uid 111); 26 Mar 2021 11:04:36 -0000 Received: from coredump.intra.peff.net (HELO sigill.intra.peff.net) (10.0.0.2) by peff.net (qpsmtpd/0.94) with (TLS_AES_256_GCM_SHA384 encrypted) ESMTPS; Fri, 26 Mar 2021 07:04:36 -0400 Authentication-Results: peff.net; auth=none Date: Fri, 26 Mar 2021 07:04:36 -0400 From: Jeff King To: =?utf-8?B?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason Cc: git@vger.kernel.org, Junio C Hamano Subject: Re: [PATCH 5/5] doc lint: lint and fix missing "GIT" end sections Message-ID: References: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org 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