git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC PATCH] prefix_path: show gitdir when arg is outside repo

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Feb 15, 2020, 00:02 UTC
Message-ID
<20200215000230.GA6134@camp.crustytoothpaste.net>
In-Reply-To
<20200214232933.243520-1-emilyshaffer@google.com>
On 2020-02-14 at 23:29:33, emilyshaffer@google.com wrote:
Show 29 quoted lines
> From: Emily Shaffer <emilyshaffer@google.com>
> 
> When developing a script, it can be painful to understand why Git thinks
> something is outside the current repo, if the current repo isn't what
> the user thinks it is. Since this can be tricky to diagnose, especially
> in cases like submodules or nested worktrees, let's give the user a hint
> about which repository is offended about that path.
> 
> Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
> ---
> This one comes from a user feature request. This user is running some
> Git client commands on a build machine somewhere and finding it hard to
> reason about the cause of the "outside repo" error.
> 
> I see two arguments:
> 
> For:
>  - A user checking their own `pwd` might still not come to the same
>    conclusion Git does about the current repo, if their filesystem is in
>    some weird state
>  - This warning is intended for human eyes (die(), stderr) so it's reasonable
>    to give some info to make the human's life easier
> 
> Against:
>  - It's chatty, especially given the absolute directory. This may be a
>    pretty common mistake ('git add' with thumbfingers?) so it could be
>    chatty, frequently - not great.
>    (Sidebar: Just including the relative directory is really not very
>    useful - since you're still left thinking, "relative to where?")

I'm very much in favor of this patch. I recently ran into a similar problem with Git LFS with path canonicalization and having both paths in the error message made it immediately obvious what the problem was.

Show 11 quoted lines
> diff --git a/pathspec.c b/pathspec.c
> index 128f27fcb7..5d661df5cf 100644
> --- a/pathspec.c
> +++ b/pathspec.c
> @@ -439,7 +439,8 @@ static void init_pathspec_item(struct pathspec_item *item, unsigned flags,
>  		match = prefix_path_gently(prefix, prefixlen,
>  					   &prefixlen, copyfrom);
>  		if (!match)
> -			die(_("%s: '%s' is outside repository"), elt, copyfrom);
> +			die(_("%s: '%s' is outside repository at '%s'"), elt,
> +			    copyfrom, absolute_path(get_git_dir()));

Do we want the top level directory in these two spots instead of the git directory? I suspect that might be more helpful, since it looks like we're dealing with working tree files.

-- 
brian m. carlson: Houston, Texas, US
OpenPGP: https://keybase.io/bk2204
Previous: emilyshaffer@google.comNext: Emily Shaffer
Message 2 of 9 in “prefix_path: show gitdir when arg is outside repo”
  1. prefix_path: show gitdir when arg is outside repoemilyshaffer@google.com, Feb 14, 2020
  2. brian m. carlsonFeb 15, 2020
  3. Emily ShafferFeb 15, 2020
  4. prefix_path: show gitdir when arg is outside repoEmily Shaffer, Feb 15, 2020
  5. brian m. carlsonFeb 15, 2020
  6. Jonathan NiederFeb 28, 2020
  7. Emily ShafferMar 3, 2020
  8. prefix_path: show gitdir if worktree unavailableEmily Shaffer, Mar 3, 2020
  9. Junio C HamanoMar 3, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.