move show_pack_info() where it belongs
[gitweb.git] / Documentation / git-symbolic-ref.txt
index 1e818bb02dcad32095e5e14236d177360fe0f3a1..3d3a059c5e2e91bff2de173c5d6f8107d10b7e62 100644 (file)
@@ -3,11 +3,11 @@ git-symbolic-ref(1)
 
 NAME
 ----
-git-symbolic-ref - read and modify symbolic refs
+git-symbolic-ref - Read and modify symbolic refs
 
 SYNOPSIS
 --------
-'git-symbolic-ref' [-q] <name> [<ref>]
+'git-symbolic-ref' [-q] [-m <reason>] <name> [<ref>]
 
 DESCRIPTION
 -----------
@@ -27,10 +27,15 @@ 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
@@ -44,10 +49,14 @@ 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.
 
+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.
+
 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite