mirror of
https://github.com/git/git.git
synced 2024-11-01 06:47:52 +01:00
a8d05d72b9
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 <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
56 lines
1.6 KiB
Text
56 lines
1.6 KiB
Text
git-symbolic-ref(1)
|
|
===================
|
|
|
|
NAME
|
|
----
|
|
git-symbolic-ref - Read and modify symbolic refs
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git symbolic-ref' [-q] [-m <reason>] <name> [<ref>]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Given one argument, reads which branch head the given symbolic
|
|
ref refers to and outputs its path, relative to the `.git/`
|
|
directory. Typically you would give `HEAD` as the <name>
|
|
argument to see which branch your working tree is on.
|
|
|
|
Given two arguments, creates or updates a symbolic ref <name> to
|
|
point at the given branch <ref>.
|
|
|
|
A symbolic ref is a regular file that stores a string that
|
|
begins with `ref: refs/`. For example, your `.git/HEAD` is
|
|
a regular file whose contents is `ref: refs/heads/master`.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
-q::
|
|
--quiet::
|
|
Do not issue an error message if the <name> is not a
|
|
symbolic ref but a detached HEAD; instead exit with
|
|
non-zero status silently.
|
|
|
|
-m::
|
|
Update the reflog for <name> with <reason>. This is valid only
|
|
when creating or updating a symbolic ref.
|
|
|
|
NOTES
|
|
-----
|
|
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`.
|
|
But symbolic links are not entirely portable, so they are now
|
|
deprecated and symbolic refs (as described above) are used by
|
|
default.
|
|
|
|
'git symbolic-ref' will exit with status 0 if the contents of the
|
|
symbolic ref were printed correctly, with status 1 if the requested
|
|
name is not a symbolic ref, or 128 if another error occurs.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|