path: root/Documentation/git-symbolic-ref.txt
diff options
authorMichael Haggerty <>2011-12-07 15:20:16 (GMT)
committerJunio C Hamano <>2011-12-08 19:10:12 (GMT)
commita8d05d72b9fd60fe63f249250dcab2352b7b1984 (patch)
treee456c1ef8a4224cbbcaf5ed6d28a70a037273cdc /Documentation/git-symbolic-ref.txt
parentc34ba9967c0cf882bbdaf87bd72fa84e0ef099ed (diff)
git symbolic-ref: documentation fix
The old "git symbolic-ref" manpage seemed to imply in one place that symlinks are still the default way to represent symbolic references and in another that symlinks are deprecated. Fix the text and shorten the justification for the change of implementation. Signed-off-by: Michael Haggerty <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-symbolic-ref.txt')
1 files changed, 3 insertions, 6 deletions
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 75b1ae5..a45d4c4 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -43,12 +43,9 @@ In the past, `.git/HEAD` was a symbolic link pointing at
`refs/heads/master`. When we wanted to switch to another branch,
we did `ln -sf refs/heads/newbranch .git/HEAD`, and when we wanted
to find out which branch we are on, we did `readlink .git/HEAD`.
-This was fine, and internally that is what still happens by
-default, but on platforms that do not have working symlinks,
-or that do not have the `readlink(1)` command, this was a bit
-cumbersome. On some platforms, `ln -sf` does not even work as
-advertised (horrors). Therefore symbolic links are now deprecated
-and symbolic refs are used by default.
+But symbolic links are not entirely portable, so they are now
+deprecated and symbolic refs (as described above) are used by
'git symbolic-ref' will exit with status 0 if the contents of the
symbolic ref were printed correctly, with status 1 if the requested