meson: fix building technical and howto docs
Subsystems (2)
PATCH 1/1 meson: fix building technical and howto docs
From: Phillip Wood <[email protected]>
When our asciidoc files were renamed from "*.txt" to "*.adoc" in 1f010d6bdf7 (doc: use .adoc extension for AsciiDoc files, 2025-01-20) the "meson.build" file in "Documentation" was updated but the "meson.build" files in the "technical" and "howto" subdirectories were not. This causes the meson build to fail when configured with -Ddocs=html. Fix this by updating the relevant "meson.build" files.
---
meson: fix building technical and howto docs
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1870%2Fphillipwood%2Fmeson-doc-fixes-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1870/phillipwood/meson-doc-fixes-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1870
Documentation/howto/meson.build | 34 ++++++++-------- Documentation/technical/meson.build | 62 ++++++++++++++--------------- 2 files changed, 48 insertions(+), 48 deletions(-)
Documentation/howto/meson.build +17 -17
@@ -1,20 +1,20 @@ howto_sources = [ - 'coordinate-embargoed-releases.txt', - 'keep-canonical-history-correct.txt', - 'maintain-git.txt', - 'new-command.txt', - 'rebase-from-internal-branch.txt', - 'rebuild-from-update-hook.txt', - 'recover-corrupted-blob-object.txt', - 'recover-corrupted-object-harder.txt', - 'revert-a-faulty-merge.txt', - 'revert-branch-rebase.txt', - 'separating-topic-branches.txt', - 'setup-git-server-over-http.txt', - 'update-hook-example.txt', - 'use-git-daemon.txt', - 'using-merge-subtree.txt', - 'using-signed-tag-in-pull-request.txt', + 'coordinate-embargoed-releases.adoc', + 'keep-canonical-history-correct.adoc', + 'maintain-git.adoc', + 'new-command.adoc', + 'rebase-from-internal-branch.adoc', + 'rebuild-from-update-hook.adoc', + 'recover-corrupted-blob-object.adoc', + 'recover-corrupted-object-harder.adoc', + 'revert-a-faulty-merge.adoc', + 'revert-branch-rebase.adoc', + 'separating-topic-branches.adoc', + 'setup-git-server-over-http.adoc', + 'update-hook-example.adoc', + 'use-git-daemon.adoc', + 'using-merge-subtree.adoc', + 'using-signed-tag-in-pull-request.adoc', ] howto_index = custom_target(
@@ -26,7 +26,7 @@ howto_index = custom_target( env: script_environment, capture: true, input: howto_sources, - output: 'howto-index.txt', + output: 'howto-index.adoc', ) custom_target(
Documentation/technical/meson.build +31 -31
75 lines not on this page · raw message
base-commit: 03944513488db4a81fdb4c21c3b515e4cb260b05
Signature · 1 line
gitgitgadget
Quoted 8 lines · Phillip Wood via GitGitGadget
From: Phillip Wood <[email protected]>
When our asciidoc files were renamed from "*.txt" to "*.adoc" in
1f010d6bdf7(doc: use .adoc extension for AsciiDoc files, 2025-01-20) the "meson.build" file in "Documentation" was updated but the "meson.build" files in the "technical" and "howto" subdirectories were not. This causes the meson build to fail when configured with -Ddocs=html. Fix this by updating the relevant "meson.build" files.
Good catch, thanks! I wonder: do we maybe also want to start building documentation with Meson so that we would catch issues like this earlier?
In any case, I'm happy to defer that to a later point and for now only land the fix.
Patrick
Hi Patrick
Quoted 10 lines · Patrick Steinhardt
Quoted 8 lines · Phillip Wood via GitGitGadget
From: Phillip Wood <[email protected]>
When our asciidoc files were renamed from "*.txt" to "*.adoc" in
1f010d6bdf7(doc: use .adoc extension for AsciiDoc files, 2025-01-20) the "meson.build" file in "Documentation" was updated but the "meson.build" files in the "technical" and "howto" subdirectories were not. This causes the meson build to fail when configured with -Ddocs=html. Fix this by updating the relevant "meson.build" files.
Quoted 3 lines
Good catch, thanks! I wonder: do we maybe also want to start building documentation with Meson so that we would catch issues like this earlier?
I think that would be a good idea.
Quoted 2 lines
In any case, I'm happy to defer that to a later point and for now only land the fix.
Yes, I was hoping this minimal fix would be acceptable for inclusion in the upcoming release. We can change the CI once that's out the door.
Best Wishes
Phillip
Quoted 1 line
Patrick
Quoted 3 lines · Phillip Wood
Yes, I was hoping this minimal fix would be acceptable for inclusion in the upcoming release. We can change the CI once that's out the door.
Thanks, both. Will queue.