From: Jon Seymour <jon.seymour@gmail.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, jrnieder@gmail.com, pclouds@gmail.com,
Jon Seymour <jon.seymour@gmail.com>
Subject: [PATCH v1] Documentation: git-rev-parse: clarify that --git-dir does not necessarily show relative paths
Date: Fri, 18 May 2012 19:23:24 +1000 [thread overview]
Message-ID: <1337333004-23164-1-git-send-email-jon.seymour@gmail.com> (raw)
In-Reply-To: <20120517182304.GA14367@burratino>
The previous documentation 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>
---
Documentation/git-rev-parse.txt | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index f63b81a..4cc3e95 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -137,7 +137,8 @@ shown. If the pattern does not contain a globbing character (`?`,
--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
--
1.7.10.1.514.ge33c7ea
next prev parent reply other threads:[~2012-05-18 9:23 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-05-17 9:03 git rev-parse --git-dir does report yield relative path to git directory, per documentation Jon Seymour
2012-05-17 16:38 ` Junio C Hamano
2012-05-17 18:23 ` Jonathan Nieder
2012-05-18 9:23 ` Jon Seymour [this message]
2012-05-18 9:31 ` [PATCH v1] Documentation: git-rev-parse: clarify that --git-dir does not necessarily show relative paths Jonathan Nieder
2012-05-18 19:24 ` Junio C Hamano
2012-05-18 10:23 ` Nguyen Thai Ngoc Duy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1337333004-23164-1-git-send-email-jon.seymour@gmail.com \
--to=jon.seymour@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=pclouds@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).