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

Re: [PATCH v13 02/15] path.c: refactor relative_path(), not only strip prefix

From
Michael Haggerty <mhagger@alum.mit.edu>
Date
May 22, 2013, 08:06 UTC
Message-ID
<519C7CA1.2060402@alum.mit.edu>
In-Reply-To
<d730f00edb09449bf299be8d2083c895a1028c18.1369186574.git.worldhello.net@gmail.com>
Sorry for coming late to the party.
On 05/22/2013 03:40 AM, Jiang Xin wrote:
Show 26 quoted lines
> Original design of relative_path() is simple, just strip the prefix
> (*base) from the absolute path (*abs). In most cases, we need a real
> relative path, such as: ../foo, ../../bar. That's why there is another
> reimplementation (path_relative()) in quote.c.
> 
> Refactor relative_path() in path.c to return real relative path, so
> that user can reuse this function without reimplement his/her own.
> I will use this method for interactive git-clean later. Some of the
> implementations are borrowed from path_relative() in quote.c.
> 
> Different results for relative_path() before and after this refactor:
> 
>     abs path  base path  relative (original)  relative (refactor)
>     ========  =========  ===================  ===================
>     /a/b/c/   /a/b       c/                   c/
>     /a/b//c/  //a///b/   c/                   c/
>     /a/b      /a/b       .                    ./
>     /a/b/     /a/b       .                    ./
>     /a        /a/b/      /a                   ../
>     /         /a/b/      /                    ../../
>     /a/c      /a/b/      /a/c                 ../c
>     /a/b      (empty)    /a/b                 /a/b
>     /a/b      (null)     /a/b                 /a/b
>     (empty)   /a/b       (empty)              ./
>     (null)    (empty)    (null)               ./
>     (null)    /a/b       (segfault)           ./

The old and new versions both seem to be (differently) inconsistent about when the output has a trailing slash. What is the rule?

Show 17 quoted lines
> diff --git a/path.c b/path.c
> index 04ff..0174d 100644
> --- a/path.c
> +++ b/path.c
> @@ -441,42 +441,104 @@ int adjust_shared_perm(const char *path)
>  	return 0;
>  }
>  
> -const char *relative_path(const char *abs, const char *base)
> +/*
> + * Give path as relative to prefix.
> + *
> + * The strbuf may or may not be used, so do not assume it contains the
> + * returned path.
> + */
> +const char *relative_path(const char *abs, const char *base,
> +			  struct strbuf *sb)
Thanks for adding documentation.  But I think it could be improved:
* The comment refers to "path" and "prefix" but the function parameters
are "abs" and "base".  I suggest making them agree.
* Who owns the memory pointed to by the return value?
* The comment says that "the strbuf may or may not be used".  So why is
it part of the interface?  (I suppose it is because the strbuf might be
given ownership of the returned memory if it has to be allocated.)
Would it be more straightforward to *always* return the result in the
strbuf?
* Please document when the return value contains a trailing slash and
also that superfluous internal slashes are (apparently) normalized away.
* Leading double-slashes have a special meaning on some operating
systems.  The old and new versions of this function both seem to ignore
differences between initial slashes.  Perhaps somebody who knows the
rules better could say whether this is an issue but I guess the problem
would rarely be encountered in practice.
Michael
-- 
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/
Previous: Jiang XinNext: Junio C Hamano
Message 7 of 38 in “Interactive git-clean”
  1. 00/15 Interactive git-cleanJiang Xin, May 18, 2013
  2. 01/15 test: add test cases for relative_pathJiang Xin, May 18, 2013
  3. Junio C HamanoMay 21, 2013
  4. 00/15 interactive git-cleanJiang Xin, May 22, 2013
  5. 01/15 test: add test cases for relative_pathJiang Xin, May 22, 2013
  6. 02/15 path.c: refactor relative_path(), not only strip prefixJiang Xin, May 22, 2013
  7. Michael HaggertyMay 22, 2013
  8. Junio C HamanoMay 22, 2013
  9. Jiang XinMay 26, 2013
  10. Jiang XinMay 30, 2013
  11. 03/15 quote.c: remove path_relative, use relative_path insteadJiang Xin, May 22, 2013
  12. 04/15 Refactor quote_path_relative, remove unused paramsJiang Xin, May 22, 2013
  13. 05/15 Refactor write_name_quoted_relative, remove unused paramsJiang Xin, May 22, 2013
  14. 06/15 git-clean: refactor git-clean into two phasesJiang Xin, May 22, 2013
  15. 07/15 git-clean: add support for -i/--interactiveJiang Xin, May 22, 2013
  16. 08/15 git-clean: show items of del_list in columnsJiang Xin, May 22, 2013
  17. 09/15 git-clean: add colors to interactive git-cleanJiang Xin, May 22, 2013
  18. 10/15 git-clean: use a git-add-interactive compatible UIJiang Xin, May 22, 2013
  19. 11/15 git-clean: add filter by pattern interactive actionJiang Xin, May 22, 2013
  20. 12/15 git-clean: add select by numbers interactive actionJiang Xin, May 22, 2013
  21. 13/15 git-clean: add ask each interactive actionJiang Xin, May 22, 2013
  22. 14/15 git-clean: add documentation for interactive git-cleanJiang Xin, May 22, 2013
  23. 15/15 test: add t7301 for git-clean--interactiveJiang Xin, May 22, 2013
  24. 02/15 path.c: refactor relative_path(), not only strip prefixJiang Xin, May 18, 2013
  25. 03/15 quote.c: remove path_relative, use relative_path insteadJiang Xin, May 18, 2013
  26. 04/15 Refactor quote_path_relative, remove unused paramsJiang Xin, May 18, 2013
  27. 05/15 Refactor write_name_quoted_relative, remove unused paramsJiang Xin, May 18, 2013
  28. 06/15 git-clean: refactor git-clean into two phasesJiang Xin, May 18, 2013
  29. 07/15 git-clean: add support for -i/--interactiveJiang Xin, May 18, 2013
  30. 08/15 git-clean: show items of del_list in columnsJiang Xin, May 18, 2013
  31. 09/15 git-clean: add colors to interactive git-cleanJiang Xin, May 18, 2013
  32. 10/15 git-clean: use a git-add-interactive compatible UIJiang Xin, May 18, 2013
  33. 11/15 git-clean: add filter by pattern interactive actionJiang Xin, May 18, 2013
  34. 12/15 git-clean: add select by numbers interactive actionJiang Xin, May 18, 2013
  35. 13/15 git-clean: add ask each interactive actionJiang Xin, May 18, 2013
  36. 14/15 git-clean: add documentation for interactive git-cleanJiang Xin, May 18, 2013
  37. 15/15 test: add t7301 for git-clean--interactiveJiang Xin, May 18, 2013
  38. Junio C HamanoMay 20, 2013

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.