aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-rev-parse.txt
diff options
context:
space:
mode:
authorJon Seymour <jon.seymour@gmail.com>2012-05-18 19:23:24 +1000
committerJunio C Hamano <gitster@pobox.com>2012-05-18 12:23:01 -0700
commitd0740ce0ba9417c34e00b5a61161d84f85ba7fbc (patch)
treec2f540d22a05a93fca96adfaaf79c33c638475ca /Documentation/git-rev-parse.txt
parent80d868b068b9e68a4aac91be578a8f097f45d8da (diff)
downloadgit-d0740ce0ba9417c34e00b5a61161d84f85ba7fbc.tar.gz
rev-parse doc: --git-dir does not always show a relative path
The description was misleading because it lead the reader to believe that --git-dir would always show a relative path when, in fact, the actual behaviour does not guarantee this. Rather, it was intended that the advice be given that if a relative path is shown, then the path is relative to the current working directory and not some other directory (for example, the root of the working tree). Signed-off-by: Jon Seymour <jon.seymour@gmail.com> Acked-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-rev-parse.txt')
-rw-r--r--Documentation/git-rev-parse.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index ff23cb0219..00e73c84c7 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -137,7 +137,8 @@ appending `/{asterisk}`.
--git-dir::
Show `$GIT_DIR` if defined. Otherwise show the path to
- the .git directory, relative to the current directory.
+ the .git directory. The path shown, when relative, is
+ relative to the current working directory.
+
If `$GIT_DIR` is not defined and the current directory
is not detected to lie in a git repository or work tree