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>
Paul Tan committed
Mar 31, 2015 at 21:39 UTC
c8c3f1d087f2195fd6ef61d6cca8241a808ac11a
1 file changed
+3
-8
path.c
+3
-8
@@ -301,14 +301,9 @@ return_null:
301
* (3) "relative/path" to mean cwd relative directory; or
302
* (4) "/absolute/path" to mean absolute directory.
303
*
304
- * Unless "strict" is given, we try access() for existence of "%s.git/.git",
305
- * "%s/.git", "%s.git", "%s" in this order. The first one that exists is
306
- * what we try.
307
- *
308
- * Second, we try chdir() to that. Upon failure, we return NULL.
309
- *
310
- * Then, we try if the current directory is a valid git repository.
311
- * Upon failure, we return NULL.
304
+ * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
305
+ * in this order. We select the first one that is a valid git repository, and
306
+ * chdir() to it. If none match, or we fail to chdir, we return NULL.
307
*
308
* If all goes well, we return the directory we used to chdir() (but
309
* before ~user is expanded), avoiding getcwd() resolving symbolic