]> git.ipfire.org Git - thirdparty/git.git/commit
docs: fix repository-layout when building with breaking changes
authorPhillip Wood <phillip.wood@dunelm.org.uk>
Wed, 5 Mar 2025 10:42:37 +0000 (10:42 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 5 Mar 2025 15:25:11 +0000 (07:25 -0800)
commit92f8da8de36decbfcc4e30dc069b2c9ea28e3f6a
treef3b51e59683ebc7b76493184bb7ac10eabfc00f4
parent6a64ac7b014fa2cfa7a69af3c253bcd53a94b428
docs: fix repository-layout when building with breaking changes

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 "with-breaking-changes"
and use it to make the inclusion of those sections of the documentation
conditional. Note that the name of the attribute does not match the test
prerequisite WITHOUT_BREAKING_CHANGES added in c5bc9a7f94a (Makefile:
wire up build option for deprecated features, 2025-01-22). This is to
avoid the awkward double negative ifndef::without_breaking_changes for
documentation that should be included when WITH_BREAKING_CHANGES is
enabled. The test prerequisite will be renamed to match the
documentation attribute in a future patch series.

Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/Makefile
Documentation/gitrepository-layout.adoc
Documentation/meson.build