Skip to content

Commit a8d05d7

Browse files
mhaggergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c34ba99 commit a8d05d7

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

Documentation/git-symbolic-ref.txt

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,9 @@ In the past, `.git/HEAD` was a symbolic link pointing at
4343
`refs/heads/master`. When we wanted to switch to another branch,
4444
we did `ln -sf refs/heads/newbranch .git/HEAD`, and when we wanted
4545
to find out which branch we are on, we did `readlink .git/HEAD`.
46-
This was fine, and internally that is what still happens by
47-
default, but on platforms that do not have working symlinks,
48-
or that do not have the `readlink(1)` command, this was a bit
49-
cumbersome. On some platforms, `ln -sf` does not even work as
50-
advertised (horrors). Therefore symbolic links are now deprecated
51-
and symbolic refs are used by default.
46+
But symbolic links are not entirely portable, so they are now
47+
deprecated and symbolic refs (as described above) are used by
48+
default.
5249

5350
'git symbolic-ref' will exit with status 0 if the contents of the
5451
symbolic ref were printed correctly, with status 1 if the requested

0 commit comments

Comments
 (0)