From: Dragan Simic <dsimic@manjaro.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: rsbecker@nexbridge.com, 'Josh Triplett' <josh@joshtriplett.org>,
git@vger.kernel.org
Subject: Re: [PATCH] advice: Add advice.scissors to suppress "do not modify or remove this line"
Date: Wed, 17 Apr 2024 06:00:12 +0200 [thread overview]
Message-ID: <9eede976d6be7a93199f9d53e916431a@manjaro.org> (raw)
In-Reply-To: <xmqqv84hc53e.fsf@gitster.g>
Hello all,
Please see my comments below.
On 2024-04-17 00:31, Junio C Hamano wrote:
> <rsbecker@nexbridge.com> writes:
>> I am having a bit of trouble understanding the use-case for
>> this. Is it limited to linkgit? Under what circumstances would I
>> need to use such capabilities?
>
> When you run "git commit" from the command line without specifying
> any message, you'd get an editor spawned for you with something like
> this in the file ("--- >8 ---" and "--- 8< ---" are for illustration
> purposes in this message).
>
> --- >8 ---
>
> # Please enter the commit message for your changes. Lines starting
> # with '#' will be ignored, and an empty message aborts the commit.
> #
> # On branch next
> # Untracked files:
> # +runme.sh
> # P
> #
> --- 8< ---
Frankly, I'd much rather see a new configuration option that would
suppress the two leading lines in the example above. Of course, they'd
still be displayed by default.
> But when you run "git commit --cleanup=scissors" (or use the
> equivalent configuration variables), you'd get this instead.
>
> --- >8 ---
>
> # ------------------------ >8 ------------------------
> # Do not modify or remove the line above.
> # Everything below it will be ignored.
> #
> # On branch next
> # Untracked files:
> # +runme.sh
> # P
> #
> --- 8< ---
>
> The new advice configuration is to suppress the two lines from that
> message template.
I think this new configuration option might be useful to some users,
but I'd suggest that it gets extended to also suppress the two opening
lines mentioned in my comment on the first example above.
> I agree that a bit more background information should be given in
> the proposed log message to help readers. It should mention when
> this new setting is relevant (e.g., when the "--cleanup=scissors"
> option is in effect), at least.
>
> I suspect that the same configuration variable wants to also control
> the "helpful" comment in the "normal" case, in which case the name
> of the configuration variable would need to be rethought.
Agreed, a better name for the new option would be helpful.
next prev parent reply other threads:[~2024-04-17 4:00 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-26 4:21 [PATCH] advice: Add advice.scissors to suppress "do not modify or remove this line" Josh Triplett
2024-04-16 19:11 ` Josh Triplett
2024-04-16 20:35 ` Junio C Hamano
2024-04-16 20:44 ` rsbecker
2024-04-16 22:31 ` Junio C Hamano
2024-04-16 22:52 ` rsbecker
2024-04-17 4:00 ` Dragan Simic [this message]
2024-04-16 20:28 ` Rubén Justo
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=9eede976d6be7a93199f9d53e916431a@manjaro.org \
--to=dsimic@manjaro.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=josh@joshtriplett.org \
--cc=rsbecker@nexbridge.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).