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

Re: [PATCH v5 4/5] setup: Add 'abspath_part_inside_repo' function

From
Martin Erik Werner <martinerikwerner@gmail.com>
Date
Feb 3, 2014, 23:16 UTC
Message-ID
<20140203231659.GC15607@mule>
In-Reply-To
<xmqq1tzjewsf.fsf@gitster.dls.corp.google.com>
On Mon, Feb 03, 2014 at 11:52:33AM -0800, Junio C Hamano wrote:
Show 36 quoted lines
> Junio C Hamano <gitster@pobox.com> writes:
> 
> > Can we have that "git foo $path" to the testsuite as well?  That is
> > the breakage we do not want to repeat in the future by regressing.
> 
> Something like this, perhaps?
> 
>  t/t3004-ls-files-basic.sh | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/t/t3004-ls-files-basic.sh b/t/t3004-ls-files-basic.sh
> index 8d9bc3c..d93089d 100755
> --- a/t/t3004-ls-files-basic.sh
> +++ b/t/t3004-ls-files-basic.sh
> @@ -36,4 +36,21 @@ test_expect_success 'ls-files -h in corrupt repository' '
>  	test_i18ngrep "[Uu]sage: git ls-files " broken/usage
>  '
>  
> +test_expect_success SYMLINKS 'ls-files with symlinks' '
> +	mkdir subs &&
> +	ln -s nosuch link &&
> +	ln -s ../nosuch subs/link &&
> +	git add link subs/link &&
> +	git ls-files -s link subs/link >expect &&
> +	git ls-files -s "$(pwd)/link" "$(pwd)/subs/link" >actual &&
> +	test_cmp expect actual &&
> +
> +	(
> +		cd subs &&
> +		git ls-files -s link >../expect &&
> +		git ls-files -s "$(pwd)/link" >../actual
> +	) &&
> +	test_cmp expect actual
> +'
> +
>  test_done

Your test looks preferrable to the simple git-add one that I proposed, since it covers some more ground than the simple:

test_expect_success SYMLINKS 'add with abs path to link...' '
	ln -s target link &&
	git add link
'

Will you add that test or should I place it in the series with you as author?

On Mon, Feb 03, 2014 at 01:00:48PM -0800, Junio C Hamano wrote:
Show 10 quoted lines
> Martin Erik Werner <martinerikwerner@gmail.com> writes:
> 
> > The path being exactly equal to the work tree is handled separately,
> > since then there is no directory separator between the work tree and
> > in-repo part.
> 
> What is an "in-repo part"?  Whatever it is, I am not sure if I
> follow that logic.  After the while (*path) loop checks each level,
> you check the whole path---wouldn't that code handle that special
> case already?

Given "/dir1/repo/dir2/file" I've used 'in-repo' to refer to "dir2/file", sometimes interchangably with "part inside the work tree" which might be better terminology, and should replace it?

I was trying to convey that if path is simply "/dir/repo", then the while loop method of replacing a '/' and checking from the beginning won't work for the last level, since it has no terminating '/' to replace, so hence it's a special case, mentioning the "part inside the work tree" is arguably confusing in that case, since there isn't really one, maybe it should be left out completely, since the "check each level" explanation covers it already?

Show 11 quoted lines
> 
> Because it is probably the normal case not to have any symbolic link
> in the leading part (hence not having to dereference them), I think
> checking "is work_tree[] a prefix of path[]" early is justified from
> performance point of view, though.
> 
> >  /*
> > + * No checking if the path is in fact an absolute path is done, and it must
> > + * already be normalized.
> 
> This is not quite parsable to me.
Hmm, what about
	The input parameter must contain an absolute path, and it must
	already be normalized.
?
Show 13 quoted lines
> > + * Find the part of an absolute path that lies inside the work tree by
> > + * dereferencing symlinks outside the work tree, for example:
> > + * /dir1/repo/dir2/file   (work tree is /dir1/repo)      -> dir2/file
> > + * /dir/file              (work tree is /)               -> dir/file
> > + * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
> > + * /dir/repolink/file     (repolink points to /dir/repo) -> file
> > + * /dir/repo              (exactly equal to work tree)   -> (empty string)
> > + */
> > +static inline int abspath_part_inside_repo(char *path)
> 
> It looks a bit too big to be marked "inline"; better leave it to the
> compiler to notice that there is only a single callsite and decide
> to (or not to) inline it.
Ok, will do.
Show 14 quoted lines
> > +{
> > +	size_t len;
> > +	size_t wtlen;
> > +	char *path0;
> > +	int off;
> > +
> > +	const char* work_tree = get_git_work_tree();
> > +	if (!work_tree)
> > +		return -1;
> > +	wtlen = strlen(work_tree);
> > +	len = strlen(path);
> 
> I expect that this is called from a callsite that _knows_ how long
> path[] is.  Shouldn't len be a parameter to this function instead?

Currently, it actually doesn't, since 'normalize_path_copy_len' is called on it prior, which can mess with the string length. Do you think the 'strlen' call should still be moved up a step into 'prefix_path_gently'?

Show 17 quoted lines
> > +	off = 0;
> > +
> > +	/* check if work tree is already the prefix */
> > +	if (strncmp(path, work_tree, wtlen) == 0) {
> 
> I wonder if we want to be explicit and compare wtlen and len before
> even attempting strncmp().  If work_tree is longer than path, it
> cannot be a prefix of path, right?
> 
> In other words, also with a style-fix to prefer !XXcmp() over
> XXcmp() == 0:
> 
> 	if (wtlen <= len && !strncmp(path, work_tree, wtlen)) {
> 
> perhaps?  That would make it clear why referring to path[wtlen] on
> the next line is permissible (it is obvious that it won't access
> past the end of path[]):
Definitely sounds like a good idea.
Show 19 quoted lines
> > +		if (path[wtlen] == '/') {
> > +			memmove(path, path + wtlen + 1, len - wtlen);
> > +			return 0;
> > +		} else if (path[wtlen - 1] == '/' || path[wtlen] == '\0') {
> > +			/* work tree is the root, or the whole path */
> > +			memmove(path, path + wtlen, len - wtlen + 1);
> 
> If work_tree[] == "/", path[] == "/a", then len == 2, wtlen == 1,
> path[wtlen - 1] == '/' and this shifts path[] to the left by one,
> leaving path[] = "a", which is what we want.  OK.
> 
> If work_tree[] == path[] == "/a", then len == wtlen == 2,
> path[wtlen] == '\0', and this becomes equivalent to path[0] = '\0'.
> Hmph....  How do our callers treat an empty path?  In other words,
> should these three be equivalent?
> 
> 	cd /a && git ls-files /a
> 	cd /a && git ls-files ""
> 	cd /a && git ls-files .

Here I have only gone by the assumption that previous code did the right thing, whether or not it *did*, I'm not sure I'm able to figure out at the moment.

Show 34 quoted lines
> > +			return 0;
> > +		}
> > +		/* work tree might match beginning of a symlink to work tree */
> > +		off = wtlen;
> > +	}
> > +	path0 = path;
> > +	path += offset_1st_component(path) + off;
> > +
> > +	/* check each level */
> > +	while (*path) {
> > +		path++;
> > +		if (*path == '/') {
> > +			*path = '\0';
> > +			if (strcmp(real_path(path0), work_tree) == 0) {
> > +				memmove(path0, path + 1, len - (path - path0));
> > +				return 0;
> > +			}
> > +			*path = '/';
> > +		}
> > +	}
> > +
> > +	/* check whole path */
> > +	if (strcmp(real_path(path0), work_tree) == 0) {
> > +		*path0 = '\0';
> > +		return 0;
> > +	}
> > +
> > +	return -1;
> > +}
> > +
> > +/*
> >   * Normalize "path", prepending the "prefix" for relative paths. If
> >   * remaining_prefix is not NULL, return the actual prefix still
> >   * remains in the path. For example, prefix = sub1/sub2/ and path is
Previous: Junio C HamanoNext: Junio C Hamano
Message 33 of 56 in “git-mv with absolute path derefereces symlinks”
  1. Martin Erik WernerJan 15, 2014
  2. 0/2 in-tree symlink handling with absolute pathsMartin Erik Werner, Jan 26, 2014
  3. 1/2 t0060: Add test for manipulating symlinks via absolute pathsMartin Erik Werner, Jan 26, 2014
  4. 2/2 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Jan 26, 2014
  5. Torsten BögershausenJan 26, 2014
  6. Martin Erik WernerJan 27, 2014
  7. 2/2 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Jan 27, 2014
  8. Duy NguyenJan 27, 2014
  9. Junio C HamanoJan 27, 2014
  10. 0/4 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Jan 31, 2014
  11. 0/4 Handling of in-tree symlinks for absolute pathsMartin Erik Werner, Feb 2, 2014
  12. 1/4 t0060: Add test for manipulating symlinks via absolute pathsMartin Erik Werner, Feb 2, 2014
  13. 2/4 t0060: Add test for prefix_path when path == work treeMartin Erik Werner, Feb 2, 2014
  14. 3/4 setup: Add 'abspath_part_inside_repo' functionMartin Erik Werner, Feb 2, 2014
  15. Duy NguyenFeb 2, 2014
  16. Duy NguyenFeb 2, 2014
  17. Martin Erik WernerFeb 2, 2014
  18. David KastrupFeb 2, 2014
  19. Torsten BögershausenFeb 2, 2014
  20. Martin Erik WernerFeb 2, 2014
  21. Torsten BögershausenFeb 2, 2014
  22. Duy NguyenFeb 2, 2014
  23. 4/4 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Feb 2, 2014
  24. 0/5 Handling of in-tree symlinks for absolute pathsMartin Erik Werner, Feb 2, 2014
  25. 1/5 t0060: Add test for manipulating symlinks via absolute pathsMartin Erik Werner, Feb 2, 2014
  26. Junio C HamanoFeb 3, 2014
  27. Junio C HamanoFeb 3, 2014
  28. Martin Erik WernerFeb 3, 2014
  29. 2/5 t0060: Add test for prefix_path when path == work treeMartin Erik Werner, Feb 2, 2014
  30. 3/5 t0060: Add tests for prefix_path when path begins with work treeMartin Erik Werner, Feb 2, 2014
  31. 4/5 setup: Add 'abspath_part_inside_repo' functionMartin Erik Werner, Feb 2, 2014
  32. Junio C HamanoFeb 3, 2014
  33. Martin Erik WernerFeb 3, 2014
  34. Junio C HamanoFeb 4, 2014
  35. Martin Erik WernerFeb 4, 2014
  36. 5/5 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Feb 2, 2014
  37. Duy NguyenFeb 3, 2014
  38. Martin Erik WernerFeb 3, 2014
  39. Junio C HamanoFeb 4, 2014
  40. 0/6 Handling of in-tree symlinks for absolute pathsMartin Erik Werner, Feb 4, 2014
  41. 1/6 t3004: Add test for ls-files on symlinks via absolute pathsMartin Erik Werner, Feb 4, 2014
  42. 2/6 t0060: Add test for prefix_path on symlinks via absolute pathsMartin Erik Werner, Feb 4, 2014
  43. 3/6 t0060: Add test for prefix_path when path == work treeMartin Erik Werner, Feb 4, 2014
  44. 4/6 t0060: Add tests for prefix_path when path begins with work treeMartin Erik Werner, Feb 4, 2014
  45. Torsten BögershausenFeb 4, 2014
  46. Junio C HamanoFeb 4, 2014
  47. 5/6 setup: Add 'abspath_part_inside_repo' functionMartin Erik Werner, Feb 4, 2014
  48. Junio C HamanoFeb 4, 2014
  49. 6/6 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Feb 4, 2014
  50. 1/4 t0060: Add test for manipulating symlinks via absolute pathsMartin Erik Werner, Jan 31, 2014
  51. 2/4 t0060: Add test for prefix_path when path == work treeMartin Erik Werner, Jan 31, 2014
  52. 3/4 setup: Add 'abspath_part_inside_repo' functionMartin Erik Werner, Jan 31, 2014
  53. Torsten BögershausenJan 31, 2014
  54. Martin Erik WernerFeb 1, 2014
  55. Duy NguyenFeb 1, 2014
  56. 4/4 setup: Don't dereference in-tree symlinks for absolute pathsMartin Erik Werner, Jan 31, 2014

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.