[RFC/PATCH] lockfile: show absolute filename in unable_to_lock_message.

[RFC/PATCH] lockfile: show absolute filename in unable_to_lock_message.

[Matthieu Moy]

When calling a git command from a subdirectory and a file locking fails,
the user will get a path relative to the root of the worktree, which is
invalid from the place where the command is ran. Make it easy for the
user to know which file it is.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
I'm writting this because I just got the situation with students:

- Sir, we broke our repository (git commit interrupted violently).
- See, the error message tells you what to do.
- But sir, where is .git/index.lock, we can't find it.

This patch would have solved their problem. OTOH, an absolute path can
be rather long and painfull to read/cut-and-paste. I've tried to show
a path relative to where the command was ran (like
"../../.git/index.lock"), but that's really a painfull to implement
(one has to provide a prefix argument to all the calls to
unable_to_lock_*, and even with this, I didn't find the simple way to
make the relative path (probably exists somewhere in Git since 'git
status' does this). Then I gave up :-(.

 lockfile.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/lockfile.c b/lockfile.c
index 6851fa5..e31cbc7 100644
--- a/lockfile.c
+++ b/lockfile.c
@@ -164,9 +164,10 @@ static char *unable_to_lock_message(const char *path, int err)
 		    "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.",
-		    path, strerror(err));
+			    make_absolute_path(path), strerror(err));
 	} else
-		strbuf_addf(&buf, "Unable to create '%s.lock': %s", path, strerror(err));
+		strbuf_addf(&buf, "Unable to create '%s.lock': %s",
+			    make_absolute_path(path), strerror(err));
 	return strbuf_detach(&buf, NULL);
 }
 
-- 
1.6.6.76.gd6b23.dirty

Re: [RFC/PATCH] lockfile: show absolute filename in unable_to_lock_message.

[Johannes Sixt]

Matthieu Moy schrieb:
> -		    path, strerror(err));
> +			    make_absolute_path(path), strerror(err));
>  	} else
> -		strbuf_addf(&buf, "Unable to create '%s.lock': %s", path, strerror(err));
> +		strbuf_addf(&buf, "Unable to create '%s.lock': %s",
> +			    make_absolute_path(path), strerror(err));

Since these are merely informative, wouldn't it be more suitable to use 
make_nonrelative_path()?

-- Hannes

[PATCH] lockfile: show absolute filename in unable_to_lock_message.

[Matthieu Moy]

When calling a git command from a subdirectory and a file locking fails,
the user will get a path relative to the root of the worktree, which is
invalid from the place where the command is ran. Make it easy for the
user to know which file it is.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
> Since these are merely informative, wouldn't it be more suitable to
> use make_nonrelative_path()?

Sensible, yes.

 lockfile.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/lockfile.c b/lockfile.c
index 6851fa5..b0d74cd 100644
--- a/lockfile.c
+++ b/lockfile.c
@@ -164,9 +164,10 @@ static char *unable_to_lock_message(const char *path, int err)
 		    "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.",
-		    path, strerror(err));
+			    make_nonrelative_path(path), strerror(err));
 	} else
-		strbuf_addf(&buf, "Unable to create '%s.lock': %s", path, strerror(err));
+		strbuf_addf(&buf, "Unable to create '%s.lock': %s",
+			    make_nonrelative_path(path), strerror(err));
 	return strbuf_detach(&buf, NULL);
 }
 
-- 
1.6.6.81.gda96d0

Re: [PATCH] lockfile: show absolute filename in unable_to_lock_message.

[Matthieu Moy]

Just ping-ing ...

I think the patch makes sense. Junio, can you either queue the patch,
or argue against it? I promise I'll be nice if you chose the second
option ;-).

Thanks,

Matthieu Moy <Matthieu.Moy@imag.fr> writes:

> When calling a git command from a subdirectory and a file locking fails,
> the user will get a path relative to the root of the worktree, which is
> invalid from the place where the command is ran. Make it easy for the
> user to know which file it is.
>
> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
>> Since these are merely informative, wouldn't it be more suitable to
>> use make_nonrelative_path()?
>
> Sensible, yes.
>
>  lockfile.c |    5 +++--
>  1 files changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/lockfile.c b/lockfile.c
> index 6851fa5..b0d74cd 100644
> --- a/lockfile.c
> +++ b/lockfile.c
> @@ -164,9 +164,10 @@ static char *unable_to_lock_message(const char *path, int err)
>  		    "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.",
> -		    path, strerror(err));
> +			    make_nonrelative_path(path), strerror(err));
>  	} else
> -		strbuf_addf(&buf, "Unable to create '%s.lock': %s", path, strerror(err));
> +		strbuf_addf(&buf, "Unable to create '%s.lock': %s",
> +			    make_nonrelative_path(path), strerror(err));
>  	return strbuf_detach(&buf, NULL);
>  }
>  
> -- 
> 1.6.6.81.gda96d0

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

Re: [PATCH] lockfile: show absolute filename in unable_to_lock_message.

[Junio C Hamano]

Thanks.