diff options
| author | Phillip Wood <phillip.wood@dunelm.org.uk> | 2025-03-05 10:42:37 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-03-05 07:25:11 -0800 |
| commit | 92f8da8de36decbfcc4e30dc069b2c9ea28e3f6a (patch) | |
| tree | f3b51e59683ebc7b76493184bb7ac10eabfc00f4 /Documentation/Makefile | |
| parent | 6a64ac7b014fa2cfa7a69af3c253bcd53a94b428 (diff) | |
| download | git-92f8da8de36decbfcc4e30dc069b2c9ea28e3f6a.tar.xz | |
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>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index c9a7cf662f..671267a8ac 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -224,6 +224,10 @@ asciidoc.conf: asciidoc.conf.in FORCE $(QUIET_GEN)$(call version_gen,"$(shell pwd)/..",$<,$@) endif +ifdef WITH_BREAKING_CHANGES +ASCIIDOC_EXTRA += -awith-breaking-changes +endif + ASCIIDOC_DEPS += docinfo.html SHELL_PATH ?= $(SHELL) |