From: Phillip Wood <phillip.wood@xxxxxxxxxxxxx>
Since commit 8ccc75c2452 (remote: announce removal of "branches/" and
"remotes/", 2025-01-22) enabling WITH_BREAKING_CHANGES when building git
removes support for reading branches from ".git/branches" and remotes
from ".git/remotes". However those locations are still documented in
gitrepository-layout.adoc even though the build does not support them.
Rectify this by adding a new document attribute
"without-breaking-changes" and use it to make the inclusion of those
sections of the documentation conditional. The name of the attribute is
based on the similar test prerequisite added in c5bc9a7f94a (Makefile:
wire up build option for deprecated features, 2025-01-22).
Signed-off-by: Phillip Wood <phillip.wood@xxxxxxxxxxxxx>
---
docs: fix repository-layout when building with breaking changes
I copied the name from the test prerequisite as I didn't want to have
different names for condition used in the tests and documentation. I do
have some reservations about the naming though as it means we end up
having to use ifdef::!without-breaking-changes[] or test_expect_success
!WITHOUT_BREAKING_CHANGES to document and test breaking changes which is
a double negative.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1871%2Fphillipwood%2Fbreaking-changes-documentation-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1871/phillipwood/breaking-changes-documentation-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1871
Documentation/Makefile | 4 ++++
Documentation/gitrepository-layout.adoc | 4 ++++
Documentation/meson.build | 4 ++++
3 files changed, 12 insertions(+)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index a734c6d6243..53a05eb8030 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -221,6 +221,10 @@ asciidoc.conf: asciidoc.conf.in FORCE
$(QUIET_GEN)$(call version_gen,"$(shell pwd)/..",$<,$@)
endif
+ifndef WITH_BREAKING_CHANGES
+ASCIIDOC_EXTRA += -awithout-breaking-changes
+endif
+
ASCIIDOC_DEPS += docinfo.html
SHELL_PATH ?= $(SHELL)
diff --git a/Documentation/gitrepository-layout.adoc b/Documentation/gitrepository-layout.adoc
index 6348ef1dcdf..62ef1c98c26 100644
--- a/Documentation/gitrepository-layout.adoc
+++ b/Documentation/gitrepository-layout.adoc
@@ -152,6 +152,7 @@ config.worktree::
working directory in multiple working directory setup (see
linkgit:git-worktree[1]).
+ifdef::without-breaking-changes[]
branches::
A deprecated way to store shorthands to be used
to specify a URL to 'git fetch', 'git pull' and 'git push'.
@@ -164,6 +165,7 @@ branches::
"$GIT_COMMON_DIR/branches" will be used instead.
+
Git will stop reading remotes from this directory in Git 3.0.
+endif::without-breaking-changes[]
hooks::
Hooks are customization scripts used by various Git
@@ -231,6 +233,7 @@ info/sparse-checkout::
This file stores sparse checkout patterns.
See also: linkgit:git-read-tree[1].
+ifdef::without-breaking-changes[]
remotes::
Stores shorthands for URL and default refnames for use
when interacting with remote repositories via 'git fetch',
@@ -241,6 +244,7 @@ remotes::
"$GIT_COMMON_DIR/remotes" will be used instead.
+
Git will stop reading remotes from this directory in Git 3.0.
+endif::without-breaking-changes[]
logs::
Records of changes made to refs are stored in this directory.
diff --git a/Documentation/meson.build b/Documentation/meson.build
index ead8e482131..4e4fca283c1 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -283,6 +283,10 @@ elif docs_backend == 'asciidoctor'
]
endif
+if not get_option('breaking_changes')
+ asciidoc_common_options += ['--attribute', 'without-breaking-changes']
+endif
+
git = find_program('git', required: false)
xmlto = find_program('xmlto')
base-commit: 03944513488db4a81fdb4c21c3b515e4cb260b05
--
gitgitgadget
