From: Ramsay Jones <ramsay@ramsayjones.plus.com>
Date: Wed, 08 Oct 2025 21:56:45 GMT
Subject: Re: [PATCH v2 1/4] doc: add some missing technical documents
Message-ID: <8e3aba11-90d7-4336-9cd4-b1fb4144bf69@ramsayjones.plus.com>
In-Reply-To: <aOYImjMXcFkdwar5@pks.im>



On 08/10/2025 7:45 am, Patrick Steinhardt wrote:
> On Thu, Oct 02, 2025 at 11:12:13PM +0100, Ramsay Jones wrote:
[snip]

> This builds on our existing linting rule and would catch any discrepancy
> in man pages that we have in "Documentation/technical/" that isn't
> listed in Meson.
> 
> This check isn't quite complete, there's two things missing:
> 
>   - We have an equivalent check in "Documentation/meson.build" that we
>     might want to extend to also cover articles.
> 
>   - We don't have a check to ensure that our Makefile and Meson are in
>     sync.
> 
> But regardless of that, the above check surfaces one more missing
> article:
> 
>     $ make lint-docs-meson
>         GEN doc.dep
>     make: *** Deleting file 'doc.dep'
>     tmp-meson-diff/meson.adoc tmp-meson-diff/actual.adoc differ: byte 3877, line 206
>     Meson man pages differ from actual man pages:
>     --- tmp-meson-diff/meson.adoc	2025-10-08 08:42:49.864991169 +0200
>     +++ tmp-meson-diff/actual.adoc	2025-10-08 08:42:50.072988794 +0200
>     @@ -203,6 +203,7 @@
>      git-worktree.adoc
>      git-write-tree.adoc
>      hash-function-transition.adoc
>     +large-object-promisors.adoc
>      long-running-process-protocol.adoc
>      multi-pack-index.adoc
>      packfile-uri.adoc
>     make: *** [Makefile:526: lint-docs-meson] Error 1

So, it has already paid for itself!

Thanks.

ATB,
Ramsay Jones