From: Junio C Hamano <gitster@pobox.com>
To: Phillip Wood <phillip.wood123@gmail.com>
Cc: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>,
Taylor Blau <me@ttaylorr.com>,
git@vger.kernel.org
Subject: Re: [PATCH] docs: clarify meaning of core.commentString=auto
Date: Fri, 21 Mar 2025 03:28:24 -0700 [thread overview]
Message-ID: <xmqqfrj6vfsn.fsf@gitster.g> (raw)
In-Reply-To: <6a3154e0-e7bc-45ae-b554-67ccab18727a@gmail.com> (Phillip Wood's message of "Thu, 20 Mar 2025 10:21:10 +0000")
Phillip Wood <phillip.wood123@gmail.com> writes:
> I think we'd want to start printing some advice when
> core.commentStr=auto explaining why it has been deprecated and that it
> will be removed when Git 3.0 is released. We should allow that advice
> to be suppressed setting advice.autoCommentStr (other name suggestions
> welcome). We would also want to add an item to BreakingChanges.adoc
> explaining why it is being removed and add "#ifndef
> WITH_BREAKING_CHANGES" around the code that handles
> core.commentStr=auto in builtin/commit.c and guard the documentation
> with "ifdef::with_breaking_changes[]".
All of these are good action items in a good transition plan, I
would say.
> We may want to make
> core.commentStr=auto an error when breaking changes are enabled as
> well.
I am not so sure. As commentStr is a random string that is used to
prefix any comment line, "auto" is just a (albeit weird) string, so
not doing anything special would be good enough.
prev parent reply other threads:[~2025-03-21 10:28 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-15 14:09 [PATCH] docs: clarify meaning of core.commentString=auto Oswald Buddenhagen
2025-03-17 20:17 ` Junio C Hamano
2025-03-17 21:34 ` Taylor Blau
2025-03-18 11:43 ` Oswald Buddenhagen
2025-03-18 17:15 ` Junio C Hamano
2025-03-19 18:20 ` Oswald Buddenhagen
2025-03-20 10:21 ` Phillip Wood
2025-03-21 10:28 ` Junio C Hamano [this message]
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=xmqqfrj6vfsn.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=me@ttaylorr.com \
--cc=oswald.buddenhagen@gmx.de \
--cc=phillip.wood123@gmail.com \
/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.