[PATCH] docs: add BreakingChanges to TECH_DOCS target

Phillip Wood via GitGitGadget· Mar 18, 2025, 14:41 UTC · lore

From: Phillip Wood <phillip.wood@dunelm.org.uk>

When BreakingChanges.txt was added in 57ec9254eb9 (docs: introduce document to announce breaking changes, 2024-06-14) there was no corresponding change to the Makefile to build it. Fix that by adding it to the TECH_DOCS target.

Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
---
    docs: add BreakingChanges to TECH_DOCS target

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1921%2Fphillipwood%2Fbuild-breaking-changes-docs-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1921/phillipwood/build-breaking-changes-docs-v1
Pull-Request: https://github.com/git/git/pull/1921

 Documentation/Makefile    | 1 +
 Documentation/meson.build | 1 +
 2 files changed, 2 insertions(+)

Show changes to 2 files +2 −0

Documentation/Makefile, Documentation/meson.build

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 671267a8ac7..de57d5822e4 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -109,6 +109,7 @@ SP_ARTICLES += howto/coordinate-embargoed-releases
 API_DOCS = $(patsubst %.adoc,%,$(filter-out technical/api-index-skel.adoc technical/api-index.adoc, $(wildcard technical/api-*.adoc)))
 SP_ARTICLES += $(API_DOCS)
 
+TECH_DOCS += BreakingChanges
 TECH_DOCS += DecisionMaking
 TECH_DOCS += ReviewingGuidelines
 TECH_DOCS += MyFirstContribution
diff --git a/Documentation/meson.build b/Documentation/meson.build
index 594546d68b1..b62ec5f6010 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -440,6 +440,7 @@ if get_option('docs').contains('html')
   )
 
   articles = [
+    'BreakingChanges.adoc',
     'DecisionMaking.adoc',
     'MyFirstContribution.adoc',
     'MyFirstObjectWalk.adoc',

base-commit: 683c54c999c301c2cd6f715c411407c413b1d84e

-- 
gitgitgadget

Patrick Steinhardt· Mar 19, 2025, 09:33 UTC · re: Phillip Wood via GitGitGadget · lore

Re: [PATCH] docs: add BreakingChanges to TECH_DOCS target

On Tue, Mar 18, 2025 at 02:41:40PM +0000, Phillip Wood via GitGitGadget wrote:

Show 6 quoted lines

> From: Phillip Wood <phillip.wood@dunelm.org.uk>
> 
> When BreakingChanges.txt was added in 57ec9254eb9 (docs: introduce
> document to announce breaking changes, 2024-06-14) there was no
> corresponding change to the Makefile to build it. Fix that by adding it
> to the TECH_DOCS target.

Makes sense, thanks for this improvement!

Patrick

patchdocs: add BreakingChanges to TECH_DOCS target