{"thread":{"id":"63042","subject":"[PATCH] meson: fix building technical and howto docs","startedAt":"2025-03-02T16:02:33Z","lastAt":"2025-03-03T16:37:39Z","messageCount":4,"participants":["Phillip Wood via GitGitGadget","Patrick Steinhardt","Phillip Wood","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"513367","messageId":"pull.1870.git.1740931350451.gitgitgadget@gmail.com","threadId":"63042","inReplyTo":null,"subject":"[PATCH] meson: fix building technical and howto docs","fromName":"Phillip Wood via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-03-02T16:02:30Z","receivedAt":"2025-03-02T16:02:33Z","isPatch":true,"sender":{"key":"phillip.wood@dunelm.org.uk","avatar":null},"body":"From: Phillip Wood <phillip.wood@dunelm.org.uk>\n\nWhen our asciidoc files were renamed from \"*.txt\" to \"*.adoc\" in\n1f010d6bdf7 (doc: use .adoc extension for AsciiDoc files, 2025-01-20)\nthe \"meson.build\" file in \"Documentation\" was updated but the\n\"meson.build\" files in the \"technical\" and \"howto\" subdirectories were\nnot. This causes the meson build to fail when configured with\n-Ddocs=html. Fix this by updating the relevant \"meson.build\" files.\n\nSigned-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>\n---\n    meson: fix building technical and howto docs\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1870%2Fphillipwood%2Fmeson-doc-fixes-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1870/phillipwood/meson-doc-fixes-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1870\n\n Documentation/howto/meson.build     | 34 ++++++++--------\n Documentation/technical/meson.build | 62 ++++++++++++++---------------\n 2 files changed, 48 insertions(+), 48 deletions(-)\n\ndiff --git a/Documentation/howto/meson.build b/Documentation/howto/meson.build\nindex c023c104161..961e0533629 100644\n--- a/Documentation/howto/meson.build\n+++ b/Documentation/howto/meson.build\n@@ -1,20 +1,20 @@\n howto_sources = [\n-  'coordinate-embargoed-releases.txt',\n-  'keep-canonical-history-correct.txt',\n-  'maintain-git.txt',\n-  'new-command.txt',\n-  'rebase-from-internal-branch.txt',\n-  'rebuild-from-update-hook.txt',\n-  'recover-corrupted-blob-object.txt',\n-  'recover-corrupted-object-harder.txt',\n-  'revert-a-faulty-merge.txt',\n-  'revert-branch-rebase.txt',\n-  'separating-topic-branches.txt',\n-  'setup-git-server-over-http.txt',\n-  'update-hook-example.txt',\n-  'use-git-daemon.txt',\n-  'using-merge-subtree.txt',\n-  'using-signed-tag-in-pull-request.txt',\n+  'coordinate-embargoed-releases.adoc',\n+  'keep-canonical-history-correct.adoc',\n+  'maintain-git.adoc',\n+  'new-command.adoc',\n+  'rebase-from-internal-branch.adoc',\n+  'rebuild-from-update-hook.adoc',\n+  'recover-corrupted-blob-object.adoc',\n+  'recover-corrupted-object-harder.adoc',\n+  'revert-a-faulty-merge.adoc',\n+  'revert-branch-rebase.adoc',\n+  'separating-topic-branches.adoc',\n+  'setup-git-server-over-http.adoc',\n+  'update-hook-example.adoc',\n+  'use-git-daemon.adoc',\n+  'using-merge-subtree.adoc',\n+  'using-signed-tag-in-pull-request.adoc',\n ]\n \n howto_index = custom_target(\n@@ -26,7 +26,7 @@ howto_index = custom_target(\n   env: script_environment,\n   capture: true,\n   input: howto_sources,\n-  output: 'howto-index.txt',\n+  output: 'howto-index.adoc',\n )\n \n custom_target(\ndiff --git a/Documentation/technical/meson.build b/Documentation/technical/meson.build\nindex 3a65ee59b3c..a13aafcfbb8 100644\n--- a/Documentation/technical/meson.build\n+++ b/Documentation/technical/meson.build\n@@ -1,37 +1,37 @@\n api_docs = [\n-  'api-error-handling.txt',\n-  'api-merge.txt',\n-  'api-parse-options.txt',\n-  'api-simple-ipc.txt',\n-  'api-trace2.txt',\n+  'api-error-handling.adoc',\n+  'api-merge.adoc',\n+  'api-parse-options.adoc',\n+  'api-simple-ipc.adoc',\n+  'api-trace2.adoc',\n ]\n \n articles = [\n-  'bitmap-format.txt',\n-  'build-systems.txt',\n-  'bundle-uri.txt',\n-  'commit-graph.txt',\n-  'directory-rename-detection.txt',\n-  'hash-function-transition.txt',\n-  'long-running-process-protocol.txt',\n-  'multi-pack-index.txt',\n-  'packfile-uri.txt',\n-  'pack-heuristics.txt',\n-  'parallel-checkout.txt',\n-  'partial-clone.txt',\n-  'platform-support.txt',\n-  'racy-git.txt',\n-  'reftable.txt',\n-  'remembering-renames.txt',\n-  'repository-version.txt',\n-  'rerere.txt',\n-  'scalar.txt',\n-  'send-pack-pipeline.txt',\n-  'shallow.txt',\n-  'sparse-checkout.txt',\n-  'sparse-index.txt',\n-  'trivial-merge.txt',\n-  'unit-tests.txt',\n+  'bitmap-format.adoc',\n+  'build-systems.adoc',\n+  'bundle-uri.adoc',\n+  'commit-graph.adoc',\n+  'directory-rename-detection.adoc',\n+  'hash-function-transition.adoc',\n+  'long-running-process-protocol.adoc',\n+  'multi-pack-index.adoc',\n+  'packfile-uri.adoc',\n+  'pack-heuristics.adoc',\n+  'parallel-checkout.adoc',\n+  'partial-clone.adoc',\n+  'platform-support.adoc',\n+  'racy-git.adoc',\n+  'reftable.adoc',\n+  'remembering-renames.adoc',\n+  'repository-version.adoc',\n+  'rerere.adoc',\n+  'scalar.adoc',\n+  'send-pack-pipeline.adoc',\n+  'shallow.adoc',\n+  'sparse-checkout.adoc',\n+  'sparse-index.adoc',\n+  'trivial-merge.adoc',\n+  'unit-tests.adoc',\n ]\n \n api_index = custom_target(\n@@ -43,7 +43,7 @@ api_index = custom_target(\n   ],\n   env: script_environment,\n   input: api_docs,\n-  output: 'api-index.txt',\n+  output: 'api-index.adoc',\n )\n \n custom_target(\n\nbase-commit: 03944513488db4a81fdb4c21c3b515e4cb260b05\n-- \ngitgitgadget\n"},{"id":"513392","messageId":"Z8WBw1L50zVmjGIs@pks.im","threadId":"63042","inReplyTo":"pull.1870.git.1740931350451.gitgitgadget@gmail.com","subject":"Re: [PATCH] meson: fix building technical and howto docs","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2025-03-03T10:17:39Z","receivedAt":"2025-03-03T10:17:45Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"On Sun, Mar 02, 2025 at 04:02:30PM +0000, Phillip Wood via GitGitGadget wrote:\n> From: Phillip Wood <phillip.wood@dunelm.org.uk>\n> \n> When our asciidoc files were renamed from \"*.txt\" to \"*.adoc\" in\n> 1f010d6bdf7 (doc: use .adoc extension for AsciiDoc files, 2025-01-20)\n> the \"meson.build\" file in \"Documentation\" was updated but the\n> \"meson.build\" files in the \"technical\" and \"howto\" subdirectories were\n> not. This causes the meson build to fail when configured with\n> -Ddocs=html. Fix this by updating the relevant \"meson.build\" files.\n\nGood catch, thanks! I wonder: do we maybe also want to start building\ndocumentation with Meson so that we would catch issues like this\nearlier?\n\nIn any case, I'm happy to defer that to a later point and for now only\nland the fix.\n\nPatrick\n"},{"id":"513404","messageId":"71b5dec1-a50b-4624-87a5-b1ede8767166@gmail.com","threadId":"63042","inReplyTo":"Z8WBw1L50zVmjGIs@pks.im","subject":"Re: [PATCH] meson: fix building technical and howto docs","fromName":"Phillip Wood","fromEmail":"phillip.wood123@gmail.com","sentAt":"2025-03-03T14:32:57Z","receivedAt":"2025-03-03T14:33:02Z","isPatch":true,"sender":{"key":"phillip.wood@dunelm.org.uk","avatar":null},"body":"Hi Patrick\n\nOn 03/03/2025 10:17, Patrick Steinhardt wrote:\n> On Sun, Mar 02, 2025 at 04:02:30PM +0000, Phillip Wood via GitGitGadget wrote:\n>> From: Phillip Wood <phillip.wood@dunelm.org.uk>\n>>\n>> When our asciidoc files were renamed from \"*.txt\" to \"*.adoc\" in\n>> 1f010d6bdf7 (doc: use .adoc extension for AsciiDoc files, 2025-01-20)\n>> the \"meson.build\" file in \"Documentation\" was updated but the\n>> \"meson.build\" files in the \"technical\" and \"howto\" subdirectories were\n>> not. This causes the meson build to fail when configured with\n>> -Ddocs=html. Fix this by updating the relevant \"meson.build\" files.\n> \n> Good catch, thanks! I wonder: do we maybe also want to start building\n> documentation with Meson so that we would catch issues like this\n> earlier?\n\nI think that would be a good idea.\n\n> In any case, I'm happy to defer that to a later point and for now only\n> land the fix.\n\nYes, I was hoping this minimal fix would be acceptable for inclusion in \nthe upcoming release. We can change the CI once that's out the door.\n\nBest Wishes\n\nPhillip\n\n\n> Patrick\n\n"},{"id":"513413","messageId":"xmqqy0xmvzn3.fsf@gitster.g","threadId":"63042","inReplyTo":"71b5dec1-a50b-4624-87a5-b1ede8767166@gmail.com","subject":"Re: [PATCH] meson: fix building technical and howto docs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-03-03T16:37:36Z","receivedAt":"2025-03-03T16:37:39Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Phillip Wood <phillip.wood123@gmail.com> writes:\n\n> Yes, I was hoping this minimal fix would be acceptable for inclusion\n> in the upcoming release. We can change the CI once that's out the\n> door.\n\nThanks, both.  Will queue.\n"}]}