From: Junio C Hamano <gitster@pobox.com>
To: "Phillip Wood via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Patrick Steinhardt <ps@pks.im>,
Phillip Wood <phillip.wood@dunelm.org.uk>
Subject: Re: [PATCH] docs: fix repository-layout when building with breaking changes
Date: Mon, 03 Mar 2025 10:18:05 -0800 [thread overview]
Message-ID: <xmqqbjuivuzm.fsf@gitster.g> (raw)
In-Reply-To: <pull.1871.git.1741018310447.gitgitgadget@gmail.com> (Phillip Wood via GitGitGadget's message of "Mon, 03 Mar 2025 16:11:50 +0000")
"Phillip Wood via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 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.
It was exactly the first thing that came to my mind when I saw the
change to the Makefile in the patch. Unless our breaking changes
are all removals, which is not likely to be the case in the longer
term, "without-breaking-changes" would be an invitation for
confusing double negatives.
> +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.
The above parts of the documentation getting commented out all look
sensible to exclude in a build that omits these older mechanisms.
But can we do it with !with-breaking-changes instead?
next prev parent reply other threads:[~2025-03-03 18:18 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-03 16:11 [PATCH] docs: fix repository-layout when building with breaking changes Phillip Wood via GitGitGadget
2025-03-03 18:18 ` Junio C Hamano [this message]
2025-03-04 6:35 ` Patrick Steinhardt
2025-03-04 10:23 ` Phillip Wood
2025-03-04 16:04 ` Junio C Hamano
2025-03-05 10:42 ` [PATCH v2] " Phillip Wood via GitGitGadget
2025-03-05 15:53 ` [PATCH] docs: fix check-docs with WITH_BREAKING_CHANGES Junio C Hamano
2025-03-07 10:32 ` Phillip Wood
2025-03-07 15:07 ` Phillip Wood
2025-03-07 19:55 ` Junio C Hamano
2025-03-07 22:42 ` Karthik Nayak
2025-03-09 10:52 ` Phillip Wood
2025-03-09 10:52 ` Phillip Wood
2025-03-10 6:42 ` Patrick Steinhardt
2025-03-11 14:40 ` Patrick Steinhardt
2025-03-12 10:39 ` phillip.wood123
2025-03-12 13:43 ` Patrick Steinhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqbjuivuzm.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=phillip.wood@dunelm.org.uk \
--cc=ps@pks.im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.