enter_repo(): fix docs to match code

In b3256eb (standardize and improve lookup rules for external local
repos), enter_repo() was modified to use a different precedence
ordering of suffixes for DWIM of the repository path, and to ensure
that the repository path is actually valid instead of just testing
for existence.

However, the documentation was not modified to reflect these
changes.  Fix the documentation to match the code.

Documentation contributed by Jeff King.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Paul Tan <pyokagan@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Paul Tan 2015-03-31 21:39:27 +08:00 committed by Junio C Hamano
parent 282616c72d
commit c8c3f1d087
1 changed files with 3 additions and 8 deletions

11
path.c
View File

@ -301,14 +301,9 @@ return_null:
* (3) "relative/path" to mean cwd relative directory; or * (3) "relative/path" to mean cwd relative directory; or
* (4) "/absolute/path" to mean absolute directory. * (4) "/absolute/path" to mean absolute directory.
* *
* Unless "strict" is given, we try access() for existence of "%s.git/.git", * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
* "%s/.git", "%s.git", "%s" in this order. The first one that exists is * in this order. We select the first one that is a valid git repository, and
* what we try. * chdir() to it. If none match, or we fail to chdir, we return NULL.
*
* Second, we try chdir() to that. Upon failure, we return NULL.
*
* Then, we try if the current directory is a valid git repository.
* Upon failure, we return NULL.
* *
* If all goes well, we return the directory we used to chdir() (but * If all goes well, we return the directory we used to chdir() (but
* before ~user is expanded), avoiding getcwd() resolving symbolic * before ~user is expanded), avoiding getcwd() resolving symbolic