From: Ramsay Jones <ramsay@ramsayjones•plus.com>
To: Patrick Steinhardt <ps@pks•im>
Cc: GIT Mailing-list <git@vger•kernel.org>,
Elijah Newren <newren@gmail•com>,
Derrick Stolee <stolee@gmail•com>,
Junio C Hamano <gitster@pobox•com>
Subject: Re: [PATCH v2 1/4] doc: add some missing technical documents
Date: Wed, 8 Oct 2025 22:56:45 +0100 [thread overview]
Message-ID: <8e3aba11-90d7-4336-9cd4-b1fb4144bf69@ramsayjones.plus.com> (raw)
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
next prev parent reply other threads:[~2025-10-08 21:56 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <https://lore.kernel.org/git/bcb3b3a3-bb13-4808-9363-442b5f9be05f@ramsayjones.plus.com/>
2025-10-02 22:12 ` [PATCH v2 0/4] technical docs in make build Ramsay Jones
2025-10-02 22:12 ` [PATCH v2 1/4] doc: add some missing technical documents Ramsay Jones
2025-10-08 6:45 ` Patrick Steinhardt
2025-10-08 19:00 ` Junio C Hamano
2025-10-08 22:01 ` Ramsay Jones
2025-10-08 22:33 ` Junio C Hamano
2025-10-08 21:56 ` Ramsay Jones [this message]
2025-10-02 22:12 ` [PATCH v2 2/4] doc: remembering-renames.adoc: fix asciidoc warnings Ramsay Jones
2025-10-08 3:51 ` Elijah Newren
2025-10-08 21:38 ` Ramsay Jones
2025-10-02 22:12 ` [PATCH v2 3/4] doc: sparse-checkout.adoc: " Ramsay Jones
2025-10-07 12:20 ` Kristoffer Haugsbakk
2025-10-07 22:17 ` Ramsay Jones
2025-10-08 3:57 ` Elijah Newren
2025-10-08 21:54 ` Ramsay Jones
2025-10-02 22:12 ` [PATCH v2 4/4] doc: commit-graph.adoc: fix up some formatting Ramsay Jones
2025-10-02 22:38 ` [PATCH v2 0/4] technical docs in make build Ramsay Jones
2025-10-16 20:02 ` [PATCH v3 " Ramsay Jones
2025-10-16 20:02 ` [PATCH v3 1/4] doc: remembering-renames.adoc: fix asciidoc warnings Ramsay Jones
2025-10-16 20:02 ` [PATCH v3 2/4] doc: sparse-checkout.adoc: " Ramsay Jones
2025-10-16 20:03 ` [PATCH v3 3/4] doc: commit-graph.adoc: fix up some formatting Ramsay Jones
2025-10-16 20:03 ` [PATCH v3 4/4] doc: add large-object-promisors.adoc to the docs build Ramsay Jones
2025-10-17 16:37 ` Ramsay Jones
2025-10-23 19:33 ` [PATCH v3 0/4] technical docs in make build Junio C Hamano
2025-10-23 20:06 ` Ramsay Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8e3aba11-90d7-4336-9cd4-b1fb4144bf69@ramsayjones.plus.com \
--to=ramsay@ramsayjones$(echo .)plus.com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=newren@gmail$(echo .)com \
--cc=ps@pks$(echo .)im \
--cc=stolee@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox