Re: [RFC/PATCH] lockfile: improve error message when lockfile exists

From: Moritz Neeb <lists@moritzneeb.de>
Date: Feb 28, 2016, 22:58 UTC
Message-ID: <56D37B8D.9090001@moritzneeb.de>
In-Reply-To: <1456690276-13914-1-git-send-email-Matthieu.Moy@imag.fr>

On 02/28/2016 09:11 PM, Matthieu Moy wrote:

Show 18 quoted lines

> A common mistake leading a user to see this message is to launch "git
> commit", let the editor open (and forget about it), and try again to
> commit.
> 
> The previous message was going too quickly to "a git process crashed"
> and to the advice "remove the file manually".
> 
> This patch modifies the message in two ways: first, it considers that
> "another process is running" is the norm, not the exception, and it
> explicitly hints the user to look at text editors.
> 
> The message is 2 lines longer, but this is not a problem since
> experienced users do not see the message often.
> 
> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
> This patch was written after seen one more time a student panicked
> because he had a "git commit" backgrounded.

I think git commit is almost the only case where this would happen. If the goal is have it shorter, then the editor example could be boiled down to something like "e.g. a commit". But then it is less clear on what the necessary action would be.

> 
> I'm not 100% satisfied with the new message. I don't think it harms to
> have a 5-lines message here but it's probably possible to be a bit
> more concise.

I adapted it a bit, it has about the same length but I tried to take out some repeating:

-- 8< --

diff --git a/lockfile.c b/lockfile.c
index 80d056d..ffb4c8d 100644
--- a/lockfile.c
+++ b/lockfile.c
@@ -150,9 +150,11 @@ void unable_to_lock_message(const char *path, int err, struct strbuf *buf)
 {
     if (err == EEXIST) {
         strbuf_addf(buf, "Unable to create '%s.lock': %s.\n\n"
-            "If no other git process is currently running, this probably means a\n"
-            "git process crashed in this repository earlier. Make sure no other git\n"
-            "process is running and remove the file manually to continue.",
+            "Another git process seems to be running in this repository,\n"
+            "e.g. an editor opened by git. Please make sure all processes\n"
+            "are terminated then try again. If it still fails, a git process\n"
+            "may have crashed in this repository earlier:\n"
+            "remove the file manually to continue.",
                 absolute_path(path), strerror(err));
     } else
         strbuf_addf(buf, "Unable to create '%s.lock': %s",