From: "Jean-Noël AVILA" <jn.avila@free.fr>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 3/4] read-tree.c: rework UI when merging no trees
Date: Wed, 03 May 2017 20:39:50 +0200 [thread overview]
Message-ID: <3080937.1HJCWGH9Pz@cayenne> (raw)
In-Reply-To: <20170503170401.GA28740@aiede.svl.corp.google.com>
Le mercredi 3 mai 2017, 10:04:01 CEST Jonathan Nieder a écrit :
> Hi,
>
> Jean-Noel Avila wrote:
> > Subject: read-tree.c: rework UI when merging no trees
>
> nit: this is about user-facing behavior, not an implementation detail,
> so the part before the colon can be the command that changed
> (read-tree:).
>
> nit: the word "rework" is dangerous in a commit message in the same
> way as the word "fix" --- it stands for "make better", in a vague way
> that leaves the reader guessing about how. Usually a more specific
> description can work better.
>
In fact, this patch is two fold:
* reword the question in the die() call. I realize now that when passed to
die(), the string is prepended with "fatal:". That's an hint that the question
does not require a reply, but ruling out any doubt would be better.
* rework the local logic which was inherited from history. This is
functionally equivalent to the previous version, just cleaner.
> > The initial test was inherited from a previous commit, but it is no
> > longer needed, given the following switch case. Moreover, the question
> > sentence ending the program has been replace by an assertative one.
> >
> > Signed-off-by: Jean-Noel Avila <jn.avila@free.fr>
>
> This can have a simpler, short-and-sweet motivation:
>
> read-tree -m: make error message for merging 0 trees less smart-alecky
>
> "git read-tree -m" requires a tree argument to name the tree to be
> merged in. Git uses a cutesy error message to say so and why:
>
> $ git read-tree -m
> warning: read-tree: emptying the index with no arguments is deprecated;
> use --empty fatal: just how do you expect me to merge 0 trees?
> $ git read-tree -m --empty
> fatal: just how do you expect me to merge 0 trees?
>
> When lucky, that could produce an ah-hah moment for the user, but it's
> more likely to irritate and distract them.
>
> Instead, tell the user plainly that the tree argument is required. Also
> document this requirement in the git-read-tree(1) manpage where there is
> room to explain it in a more straightforward way.
>
Thank you very much for this message! May I s-o-b you?
As hinted, I'll add the documentation part. ;-)
> Unfortunately both 'git read-tree -h' and 'git read-tree --help' say nothing
> about this. Ideas for wording there?
Next pach series will propose this.
>
> Thanks and hope that helps,
> Jonathan
next prev parent reply other threads:[~2017-05-03 18:39 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-03 16:29 [PATCH 1/4] usability: don't ask questions if no reply is required Jean-Noel Avila
2017-05-03 16:29 ` [PATCH 2/4] usability: fix am and checkout for nevermind questions Jean-Noel Avila
2017-05-03 16:51 ` Jonathan Nieder
2017-05-03 18:35 ` Jean-Noël AVILA
2017-05-03 16:29 ` [PATCH 3/4] read-tree.c: rework UI when merging no trees Jean-Noel Avila
2017-05-03 17:04 ` Jonathan Nieder
2017-05-03 18:39 ` Jean-Noël AVILA [this message]
2017-05-03 16:29 ` [PATCH 4/4] git-filter-branch: be assertative on dying message Jean-Noel Avila
2017-05-03 17:07 ` Jonathan Nieder
2017-05-03 16:47 ` [PATCH 1/4] usability: don't ask questions if no reply is required Jonathan Nieder
2017-05-03 16:58 ` Stefan Beller
2017-05-03 17:37 ` Jean-Noël AVILA
2017-05-03 21:07 ` [PATCH v2 1/3] " Jean-Noel Avila
2017-05-03 21:07 ` [PATCH v2 2/3] read-tree -m: make error message for merging 0 trees less smart aleck Jean-Noel Avila
2017-05-11 3:46 ` Junio C Hamano
2017-05-11 4:31 ` [PATCH] read-tree: "read-tree -m --empty" does not make sense Junio C Hamano
2017-05-03 21:07 ` [PATCH v2 3/3] git-filter-branch: make the error msg when missing branch more open Jean-Noel Avila
2017-05-11 3:53 ` Junio C Hamano
2017-05-04 8:52 ` [PATCH v2 1/3] usability: don't ask questions if no reply is required Kerry, Richard
2017-05-04 9:09 ` Ævar Arnfjörð Bjarmason
2017-05-04 10:14 ` Kerry, Richard
2017-05-09 8:18 ` Jean-Noël AVILA
2017-05-09 9:21 ` Ævar Arnfjörð Bjarmason
2017-05-04 9:41 ` Jean-Noël AVILA
2017-05-11 3:16 ` Junio C Hamano
2017-05-11 10:10 ` Kerry, Richard
2017-05-11 10:28 ` Konstantin Khomoutov
2017-05-11 10:33 ` Ævar Arnfjörð Bjarmason
2017-05-11 12:06 ` [PATCH v3 " Jean-Noel Avila
2017-05-11 12:06 ` [PATCH v3 2/3] read-tree -m: make error message for merging 0 trees less smart aleck Jean-Noel Avila
2017-05-11 19:08 ` Jonathan Nieder
2017-05-12 6:28 ` Junio C Hamano
2017-05-12 12:54 ` Jean-Noël AVILA
2017-05-11 12:06 ` [PATCH v3 3/3] git-filter-branch: Jean-Noel Avila
2017-05-12 6:27 ` Junio C Hamano
2017-05-12 13:03 ` [PATCH v4 1/3] usability: don't ask questions if no reply is required Jean-Noel Avila
2017-05-12 13:03 ` [PATCH v4 2/3] read-tree -m: make error message for merging 0 trees less smart aleck Jean-Noel Avila
2017-05-12 13:03 ` [PATCH v4 3/3] git-filter-branch: be more direct in an error message Jean-Noel Avila
2017-05-12 22:36 ` [PATCH v4 1/3] usability: don't ask questions if no reply is required Junio C Hamano
2017-05-13 15:37 ` Johannes Sixt
2017-05-15 2:18 ` Junio C Hamano
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=3080937.1HJCWGH9Pz@cayenne \
--to=jn.avila@free.fr \
--cc=git@vger.kernel.org \
--cc=jrnieder@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).