man1/git-symbolic-ref.1

   1 '\" t
   2 .\"     Title: git-symbolic-ref
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-02-15
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.44.0.rc1.17.g3e0d3cd5c7
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-SYMBOLIC\-REF" "1" "2024\-02\-15" "Git 2\&.44\&.0\&.rc1\&.17\&.g3" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-symbolic-ref \- Read, modify and delete symbolic refs
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit symbolic\-ref\fR [\-m <reason>] <name> <ref>
  36 \fIgit symbolic\-ref\fR [\-q] [\-\-short] [\-\-no\-recurse] <name>
  37 \fIgit symbolic\-ref\fR \-\-delete [\-q] <name>
  38 .fi
  39 .sp
  40 .SH "DESCRIPTION"
  41 .sp
  42 Given one argument, reads which branch head the given symbolic ref refers to and outputs its path, relative to the \fB\&.git/\fR directory\&. Typically you would give \fBHEAD\fR as the <name> argument to see which branch your working tree is on\&.
  43 .sp
  44 Given two arguments, creates or updates a symbolic ref <name> to point at the given branch <ref>\&.
  45 .sp
  46 Given \fB\-\-delete\fR and an additional argument, deletes the given symbolic ref\&.
  47 .sp
  48 A symbolic ref is a regular file that stores a string that begins with \fBref: refs/\fR\&. For example, your \fB\&.git/HEAD\fR is a regular file whose content is \fBref: refs/heads/master\fR\&.
  49 .SH "OPTIONS"
  50 .PP
  51 \-d, \-\-delete
  52 .RS 4
  53 Delete the symbolic ref <name>\&.
  54 .RE
  55 .PP
  56 \-q, \-\-quiet
  57 .RS 4
  58 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\&.
  59 .RE
  60 .PP
  61 \-\-short
  62 .RS 4
  63 When showing the value of <name> as a symbolic ref, try to shorten the value, e\&.g\&. from
  64 \fBrefs/heads/master\fR
  65 to
  66 \fBmaster\fR\&.
  67 .RE
  68 .PP
  69 \-\-recurse, \-\-no\-recurse
  70 .RS 4
  71 When showing the value of <name> as a symbolic ref, if <name> refers to another symbolic ref, follow such a chain of symbolic refs until the result no longer points at a symbolic ref (\fB\-\-recurse\fR, which is the default)\&.
  72 \fB\-\-no\-recurse\fR
  73 stops after dereferencing only a single level of symbolic ref\&.
  74 .RE
  75 .PP
  76 \-m
  77 .RS 4
  78 Update the reflog for <name> with <reason>\&. This is valid only when creating or updating a symbolic ref\&.
  79 .RE
  80 .SH "NOTES"
  81 .sp
  82 In the past, \fB\&.git/HEAD\fR was a symbolic link pointing at \fBrefs/heads/master\fR\&. When we wanted to switch to another branch, we did \fBln \-sf refs/heads/newbranch \&.git/HEAD\fR, and when we wanted to find out which branch we are on, we did \fBreadlink \&.git/HEAD\fR\&. But symbolic links are not entirely portable, so they are now deprecated and symbolic refs (as described above) are used by default\&.
  83 .sp
  84 \fIgit symbolic\-ref\fR 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\&.
  85 .SH "GIT"
  86 .sp
  87 Part of the \fBgit\fR(1) suite