Skip to content

Commit

Permalink
get_relative_cwd(): clarify why it handles dir == NULL
Browse files Browse the repository at this point in the history
The comment did not make a good case why it makes sense.
Clarify, and remove stale comment about the caller being lazy.
The behaviour on NULL input is pretty much intentional.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Johannes Schindelin authored and Junio C Hamano committed Aug 1, 2007
1 parent e90fdc3 commit 420acb3
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions dir.c
Original file line number Diff line number Diff line change
Expand Up @@ -646,16 +646,21 @@ file_exists(const char *f)
/*
* get_relative_cwd() gets the prefix of the current working directory
* relative to 'dir'. If we are not inside 'dir', it returns NULL.
* As a convenience, it also returns NULL if 'dir' is already NULL.
*
* As a convenience, it also returns NULL if 'dir' is already NULL. The
* reason for this behaviour is that it is natural for functions returning
* directory names to return NULL to say "this directory does not exist"
* or "this directory is invalid". These cases are usually handled the
* same as if the cwd is not inside 'dir' at all, so get_relative_cwd()
* returns NULL for both of them.
*
* Most notably, get_relative_cwd(buffer, size, get_git_work_tree())
* unifies the handling of "outside work tree" with "no work tree at all".
*/
char *get_relative_cwd(char *buffer, int size, const char *dir)
{
char *cwd = buffer;

/*
* a lazy caller can pass a NULL returned from get_git_work_tree()
* and rely on this function to return NULL.
*/
if (!dir)
return NULL;
if (!getcwd(buffer, size))
Expand Down

0 comments on commit 420acb3

Please sign in to comment.