From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Kaartic Sivaraam" <kaartic.sivaraam@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
git@vger.kernel.org
Subject: Re: [PATCH] branch: issue "-l" deprecation warning after pager starts
Date: Thu, 24 May 2018 22:40:03 -0400 [thread overview]
Message-ID: <20180525024002.GA1998@sigill.intra.peff.net> (raw)
In-Reply-To: <xmqqh8mwpkgu.fsf@gitster-ct.c.googlers.com>
On Fri, May 25, 2018 at 10:55:45AM +0900, Junio C Hamano wrote:
> Jeff King <peff@peff.net> writes:
>
> > Hmm, actually, I suppose the true value of the warning is to help people
> > doing "git branch -l foo", and it would still work there. The "more
> > extreme" from your suggested patch would only affect "branch -l".
>
> > Still, I think I prefer the gentler version that we get by keeping it as
> > a warning even in the latter case.
>
> "git branch -l newbranch [forkpoint]" that warns "We won't be doing
> reflog creation with -l" is good, but "git branch -l" that warns "We
> won't be doing reflog creation with -l" sounds like a pure noise, as
> the user would say "Irrelevant, I am not doing that anyway--I am
> listing".
>
> The warning to prepare users for the next step jk/branch-l-1-removal
> should say "we won't be accepting '-l' as a silent and unadvertised
> synonym soon. Spell it as --list" when "git branch -l" is given, I
> would think.
I hoped that reminding them that "-l is a synonym for --create-reflog"
would serve as a gentle reminder that they're Doing It Wrong. I guess we
could be more explicit, though.
It is not "we won't be accepting -l as a synonym" though. It was never a
synonym, it's just that it didn't happen to do anything in list mode.
> > @@ -700,6 +700,11 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
> > if (list)
> > setup_auto_pager("branch", 1);
> >
> > + if (used_deprecated_reflog_option) {
> > + warning("the '-l' alias for '--create-reflog' is deprecated;");
> > + warning("it will be removed in a future version of Git");
> > + }
>
> So from that point of view, we may need a separate message to warn
> users who _do_ want listing with '-l' before jk/branch-l-1-removal
> removes it?
>
> The jk/branch-l-2-resurrection topic later repurposes '-l' for
> '--list' but until that happens 'git branch -l' will error not, no?
Yes, after step 1 it will error out. Again, I hoped the existing message
would prepare people. But maybe we should do this on top of what I
posted earlier?
-- >8 --
Subject: [PATCH] branch: customize "-l" warning in list mode
People mistakenly use "git branch -l", thinking that it
triggers list mode. It doesn't, but the lack of non-option
arguments in that command does (and the "-l" becomes a
silent noop).
Since afc968e579 (branch: deprecate "-l" option, 2018-03-26)
we've warned that "-l" is going away. But the warning text
is primarily aimed at people who _meant_ to use "-l", as in
"git branch -l foo". People who mistakenly said "git branch
-l" may be left puzzled.
Let's make it clear that:
1. No, "-l" didn't do what they thought here.
2. It's going away, and what they should do instead.
Signed-off-by: Jeff King <peff@peff.net>
---
builtin/branch.c | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/builtin/branch.c b/builtin/branch.c
index 55bfacd843..b0b33dab94 100644
--- a/builtin/branch.c
+++ b/builtin/branch.c
@@ -701,8 +701,14 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
setup_auto_pager("branch", 1);
if (used_deprecated_reflog_option) {
- warning("the '-l' alias for '--create-reflog' is deprecated;");
- warning("it will be removed in a future version of Git");
+ if (list) {
+ warning("the '-l' option is an alias for '--create-reflog' and");
+ warning("has no effect in list mode. This option will soon be");
+ warning("removed and you should omit it (or use '--list' instead).");
+ } else {
+ warning("the '-l' alias for '--create-reflog' is deprecated;");
+ warning("it will be removed in a future version of Git");
+ }
}
if (delete) {
--
2.17.0.1391.g6fdbf40724
next prev parent reply other threads:[~2018-05-25 2:40 UTC|newest]
Thread overview: 95+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-17 6:01 What's cooking in git.git (May 2018, #02; Thu, 17) Junio C Hamano
2018-05-17 6:39 ` jk/branch-l-0-deprecation (was Re: What's cooking in git.git (May 2018, #02; Thu, 17)) Kaartic Sivaraam
2018-05-17 9:48 ` Ævar Arnfjörð Bjarmason
2018-05-17 11:00 ` Kaartic Sivaraam
2018-05-17 12:02 ` Ævar Arnfjörð Bjarmason
2018-05-17 13:36 ` Jeff King
2018-05-24 15:10 ` Kaartic Sivaraam
2018-05-24 19:22 ` Jeff King
2018-05-24 19:31 ` [PATCH] branch: issue "-l" deprecation warning after pager starts Jeff King
2018-05-25 1:55 ` Junio C Hamano
2018-05-25 2:40 ` Jeff King [this message]
2018-05-25 8:56 ` Junio C Hamano
2018-05-25 9:14 ` Junio C Hamano
2018-05-25 17:10 ` Jeff King
2018-05-26 2:37 ` Junio C Hamano
2018-05-25 21:00 ` [RFC PATCH 0/3] usage: prefix all lines in `vreportf()`, not just the first Martin Ågren
2018-05-25 21:00 ` [RFC PATCH 1/3] usage: extract `prefix_suffix_lines()` from `advise()` Martin Ågren
2018-05-28 8:27 ` Junio C Hamano
2018-05-28 18:40 ` Duy Nguyen
2018-05-29 21:33 ` Jeff King
2018-05-29 21:39 ` Jeff King
2018-05-30 1:42 ` Junio C Hamano
2018-05-30 6:00 ` Junio C Hamano
2018-05-30 10:26 ` Martin Ågren
2018-05-31 6:07 ` Jeff King
2018-05-25 21:00 ` [RFC PATCH 2/3] usage: prefix all lines in `vreportf()`, not just the first Martin Ågren
2018-05-28 9:25 ` Junio C Hamano
2018-05-28 18:45 ` Duy Nguyen
2018-05-28 21:45 ` Junio C Hamano
2018-05-29 4:49 ` Martin Ågren
2018-05-29 5:50 ` Junio C Hamano
2018-05-29 10:30 ` Martin Ågren
2018-05-29 12:08 ` Junio C Hamano
2018-05-29 15:50 ` Duy Nguyen
2018-05-30 10:19 ` Martin Ågren
2018-05-29 21:32 ` Jeff King
2018-05-30 10:20 ` Martin Ågren
2018-05-25 21:00 ` [RFC PATCH 3/3] usage: translate the "error: "-prefix and others Martin Ågren
2018-05-26 2:32 ` [PATCH] branch: issue "-l" deprecation warning after pager starts Junio C Hamano
2018-05-26 2:33 ` Junio C Hamano
2018-05-29 21:20 ` Jeff King
2018-05-29 21:21 ` Jeff King
2018-05-30 2:48 ` Junio C Hamano
2018-05-31 5:44 ` Jeff King
2018-05-26 19:39 ` Kaartic Sivaraam
2018-06-02 4:46 ` Duy Nguyen
2018-06-02 8:10 ` Jeff King
2018-05-26 18:45 ` Kaartic Sivaraam
2018-05-29 21:15 ` Jeff King
2018-05-30 2:52 ` Junio C Hamano
2018-05-31 5:51 ` Jeff King
2018-06-01 1:35 ` Junio C Hamano
2018-05-31 5:52 ` Kaartic.Sivaraam
2018-05-17 13:22 ` What's cooking in git.git (May 2018, #02; Thu, 17) Derrick Stolee
2018-05-17 18:20 ` Stefan Beller
2018-05-17 18:29 ` [PATCH 0/2] Reroll 2 last commits of sb/object-store-replace Stefan Beller
2018-05-17 18:29 ` [PATCH 1/2] object.c: free replace map in raw_object_store_clear Stefan Beller
2018-05-17 18:29 ` [PATCH 2/2] replace-object.c: remove the_repository from prepare_replace_object Stefan Beller
2018-05-17 18:40 ` [PATCH] merge-recursive: give notice when submodule commit gets fast-forwarded Stefan Beller
2018-05-18 19:43 ` [PATCH v2 0/1] rebased: inform about auto submodule ff Leif Middelschulte
2018-05-18 19:48 ` [PATCH v3 " Leif Middelschulte
2018-05-18 19:48 ` [PATCH 1/1] Inform about fast-forwarding of submodules during merge Leif Middelschulte
2018-05-18 21:25 ` Elijah Newren
2018-05-21 4:12 ` Junio C Hamano
2018-05-17 19:46 ` [PATCH 0/8] Reroll of sb/diff-color-move-more Stefan Beller
2018-05-17 19:46 ` [PATCH 1/8] xdiff/xdiff.h: remove unused flags Stefan Beller
2018-05-17 19:46 ` [PATCH 2/8] xdiff/xdiffi.c: remove unneeded function declarations Stefan Beller
2018-05-17 19:46 ` [PATCH 3/8] diff.c: do not pass diff options as keydata to hashmap Stefan Beller
2018-05-17 19:46 ` [PATCH 4/8] diff.c: adjust hash function signature to match hashmap expectation Stefan Beller
2018-05-17 19:46 ` [PATCH 5/8] diff.c: add a blocks mode for moved code detection Stefan Beller
2018-05-17 19:46 ` [PATCH 6/8] diff.c: decouple white space treatment from move detection algorithm Stefan Beller
2018-05-18 4:00 ` Simon Ruderich
2018-05-18 19:25 ` Stefan Beller
2018-05-17 19:46 ` [PATCH 7/8] diff.c: add --color-moved-ignore-space-delta option Stefan Beller
2018-05-17 19:46 ` [PATCH 8/8] diff: color-moved white space handling options imply color-moved Stefan Beller
2018-05-17 22:53 ` [PATCH 0/8] Reroll of sb/diff-color-move-more Jonathan Tan
2018-06-07 23:54 ` Jacob Keller
2018-05-17 22:36 ` What's cooking in git.git (May 2018, #02; Thu, 17) Junio C Hamano
2018-05-17 22:39 ` Stefan Beller
2018-05-17 22:56 ` Junio C Hamano
2018-05-17 22:58 ` Stefan Beller
2018-05-21 1:57 ` brian m. carlson
2018-05-21 17:36 ` Stefan Beller
2018-05-25 12:28 ` sb/submodule-move-nested breaks t7411 under GIT_FSMONITOR_TEST Ævar Arnfjörð Bjarmason
2018-05-25 17:27 ` Stefan Beller
2018-05-25 19:49 ` Stefan Beller
2018-09-06 12:31 ` Ævar Arnfjörð Bjarmason
2018-09-06 16:57 ` Stefan Beller
2018-09-06 19:03 ` Ben Peart
2018-09-06 20:14 ` Stefan Beller
2018-09-06 20:34 ` [PATCH] git-mv: allow submodules and fsmonitor to work together Stefan Beller
2018-09-10 15:58 ` Ben Peart
2018-09-10 16:29 ` [PATCH v1] " Ben Peart
2018-09-10 17:07 ` Stefan Beller
2018-09-10 19:38 ` Ben Peart
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180525024002.GA1998@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=kaartic.sivaraam@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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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).