# [PATCH] meson: fix building technical and howto docs 4 messages from 2025-03-02 to 2025-03-03. Participants: Phillip Wood via GitGitGadget, Patrick Steinhardt, Phillip Wood, Junio C Hamano. Thread: https://gitlist.dev/t/63042 ## Phillip Wood via GitGitGadget, 2025-03-02 16:02 Subject: [PATCH] meson: fix building technical and howto docs Message-ID: URL: https://gitlist.dev/e/pull.1870.git.1740931350451.gitgitgadget%40gmail.com ``` From: Phillip Wood 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. Signed-off-by: Phillip Wood --- 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(-) diff --git a/Documentation/howto/meson.build b/Documentation/howto/meson.build index c023c104161..961e0533629 100644 --- a/Documentation/howto/meson.build +++ b/Documentation/howto/meson.build @@ -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( diff --git a/Documentation/technical/meson.build b/Documentation/technical/meson.build index 3a65ee59b3c..a13aafcfbb8 100644 --- a/Documentation/technical/meson.build +++ b/Documentation/technical/meson.build @@ -1,37 +1,37 @@ api_docs = [ - 'api-error-handling.txt', - 'api-merge.txt', - 'api-parse-options.txt', - 'api-simple-ipc.txt', - 'api-trace2.txt', + 'api-error-handling.adoc', + 'api-merge.adoc', + 'api-parse-options.adoc', + 'api-simple-ipc.adoc', + 'api-trace2.adoc', ] articles = [ - 'bitmap-format.txt', - 'build-systems.txt', - 'bundle-uri.txt', - 'commit-graph.txt', - 'directory-rename-detection.txt', - 'hash-function-transition.txt', - 'long-running-process-protocol.txt', - 'multi-pack-index.txt', - 'packfile-uri.txt', - 'pack-heuristics.txt', - 'parallel-checkout.txt', - 'partial-clone.txt', - 'platform-support.txt', - 'racy-git.txt', - 'reftable.txt', - 'remembering-renames.txt', - 'repository-version.txt', - 'rerere.txt', - 'scalar.txt', - 'send-pack-pipeline.txt', - 'shallow.txt', - 'sparse-checkout.txt', - 'sparse-index.txt', - 'trivial-merge.txt', - 'unit-tests.txt', + 'bitmap-format.adoc', + 'build-systems.adoc', + 'bundle-uri.adoc', + 'commit-graph.adoc', + 'directory-rename-detection.adoc', + 'hash-function-transition.adoc', + 'long-running-process-protocol.adoc', + 'multi-pack-index.adoc', + 'packfile-uri.adoc', + 'pack-heuristics.adoc', + 'parallel-checkout.adoc', + 'partial-clone.adoc', + 'platform-support.adoc', + 'racy-git.adoc', + 'reftable.adoc', + 'remembering-renames.adoc', + 'repository-version.adoc', + 'rerere.adoc', + 'scalar.adoc', + 'send-pack-pipeline.adoc', + 'shallow.adoc', + 'sparse-checkout.adoc', + 'sparse-index.adoc', + 'trivial-merge.adoc', + 'unit-tests.adoc', ] api_index = custom_target( @@ -43,7 +43,7 @@ api_index = custom_target( ], env: script_environment, input: api_docs, - output: 'api-index.txt', + output: 'api-index.adoc', ) custom_target( base-commit: 03944513488db4a81fdb4c21c3b515e4cb260b05 -- gitgitgadget ``` ## Patrick Steinhardt, 2025-03-03 10:17 Subject: Re: [PATCH] meson: fix building technical and howto docs Message-ID: URL: https://gitlist.dev/e/Z8WBw1L50zVmjGIs%40pks.im In-Reply-To: ``` On Sun, Mar 02, 2025 at 04:02:30PM +0000, Phillip Wood via GitGitGadget wrote: > From: Phillip Wood > > 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 ``` ## Phillip Wood, 2025-03-03 14:32 Subject: Re: [PATCH] meson: fix building technical and howto docs Message-ID: <71b5dec1-a50b-4624-87a5-b1ede8767166@gmail.com> URL: https://gitlist.dev/e/71b5dec1-a50b-4624-87a5-b1ede8767166%40gmail.com In-Reply-To: ``` Hi Patrick On 03/03/2025 10:17, Patrick Steinhardt wrote: > On Sun, Mar 02, 2025 at 04:02:30PM +0000, Phillip Wood via GitGitGadget wrote: >> From: Phillip Wood >> >> 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? I think that would be a good idea. > 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 > Patrick ``` ## Junio C Hamano, 2025-03-03 16:37 Subject: Re: [PATCH] meson: fix building technical and howto docs Message-ID: URL: https://gitlist.dev/e/xmqqy0xmvzn3.fsf%40gitster.g In-Reply-To: <71b5dec1-a50b-4624-87a5-b1ede8767166@gmail.com> ``` Phillip Wood writes: > 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. ```