usability: don't ask questions if no reply is required

There has been a bug report by a corporate user that stated that
"spelling mistake of stash followed by a yes prints character 'y'
infinite times."

This analysis was false. When the spelling of a command contains
errors, the git program tries to help the user by providing candidates
which are close to the unexisting command. E.g Git prints the
following:

git: 'stahs' is not a git command. See 'git --help'.
Did you mean this?

stash

and then exits.

The problem with this hint is that it is not formally indicated as an
hint and the user is in fact encouraged to reply to the question,
whereas the Git command is already finished.

The user was unlucky enough that it was the command he was looking
for, and replied "yes" on the command line, effectively launching the
`yes` program.

The initial error is that the Git programs, when launched in
command-line mode (without interaction) must not ask questions,
because these questions would normally require a user input as a reply
that they won't handle indeed. That's a source of confusion on UX
level.

To improve the general usability of the Git suite, the following rule
was applied:

if the sentence
* appears in a non-interactive session
* is printed last before exit
* is a question addressing the user ("you")

the sentence is turned into affirmative and proposes the option.

The basic rewording of the question sentences has been extended to
other spots found in the source.

Requested at https://github.com/git/git-scm.com/issues/999 by rpai1

Signed-off-by: Jean-Noel Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/am.c b/builtin/am.c
index 31fb60578f6caacfb376fe84938dda9432dcfc5a..38944f79022f9dbc0805a529b83b5c6b2307cbcd 100644 (file)
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -1313,7 +1313,7 @@ static int parse_mail(struct am_state *state, const char *mail)
        }
 
        if (is_empty_file(am_path(state, "patch"))) {
        }
 
        if (is_empty_file(am_path(state, "patch"))) {

-               printf_ln(_("Patch is empty. Was it split wrong?"));
+               printf_ln(_("Patch is empty."));

                die_user_resolve(state);
        }
 
                die_user_resolve(state);
        }
 


@@ -1941,7 +1941,8 @@ static void am_resolve(struct am_state *state)
 
        if (unmerged_cache()) {
                printf_ln(_("You still have unmerged paths in your index.\n"
 
        if (unmerged_cache()) {
                printf_ln(_("You still have unmerged paths in your index.\n"

-                       "Did you forget to use 'git add'?"));
+                       "You should 'git add' each file with resolved conflicts to mark them as such.\n"
+                       "You might run `git rm` on a file to accept \"deleted by them\" for it."));

                die_user_resolve(state);
        }
 
                die_user_resolve(state);
        }
 

diff --git a/builtin/checkout.c b/builtin/checkout.c
index 81f07c3ef271db08e36ee7a89b1d128d099ecb96..8d313ceb523ea8c4b1126f47631b48dfb4e3d747 100644 (file)
--- a/builtin/checkout.c
+++ b/builtin/checkout.c
@@ -1259,9 +1259,8 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
                 * new_branch && argc > 1 will be caught later.
                 */
                if (opts.new_branch && argc == 1)
                 * new_branch && argc > 1 will be caught later.
                 */
                if (opts.new_branch && argc == 1)

-                       die(_("Cannot update paths and switch to branch '%s' at the same time.\n"
-                             "Did you intend to checkout '%s' which can not be resolved as commit?"),
-                           opts.new_branch, argv[0]);
+                       die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
+                               argv[0], opts.new_branch);

 
                if (opts.force_detach)
                        die(_("git checkout: --detach does not take a path argument '%s'"),
 
                if (opts.force_detach)
                        die(_("git checkout: --detach does not take a path argument '%s'"),

diff --git a/help.c b/help.c
index bc6cd19cf3a5e4300e32cbdd437b2d9231fd2d89..a07f01e6f9fc7895f27f3ee9a4a7e291ce995b0f 100644 (file)
--- a/help.c
+++ b/help.c
@@ -411,8 +411,8 @@ const char *help_unknown_cmd(const char *cmd)
 
        if (SIMILAR_ENOUGH(best_similarity)) {
                fprintf_ln(stderr,
 
        if (SIMILAR_ENOUGH(best_similarity)) {
                fprintf_ln(stderr,

-                          Q_("\nDid you mean this?",
-                             "\nDid you mean one of these?",
+                          Q_("\nThe most similar command is",
+                             "\nThe most similar commands are",

                           n));
 
                for (i = 0; i < n; i++)
                           n));
 
                for (i = 0; i < n; i++)