[PATCH] Rename git-repo-config to git-config.

[git.git] / Documentation / git-symbolic-ref.txt

diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 4bc35a1d4bfce9b92394ba0f3e98ed9943f66e2e..f93b79a85e1259f789551a94ab422a846cf4cf65 100644 (file)
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -3,11 +3,11 @@ git-symbolic-ref(1)
 
 NAME
 ----
 
 NAME
 ----

-git-symbolic-ref - read and modify symbolic refs
+git-symbolic-ref - Read and modify symbolic refs

 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-symbolic-ref' <name> [<ref>]
+'git-symbolic-ref' [-q] <name> [<ref>]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -23,6 +23,14 @@ 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`.
 
 begins with `ref: refs/`.  For example, your `.git/HEAD` is
 a regular file whose contents is `ref: refs/heads/master`.
 

+OPTIONS
+-------
+
+-q::
+       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.
+

 NOTES
 -----
 In the past, `.git/HEAD` was a symbolic link pointing at
 NOTES
 -----
 In the past, `.git/HEAD` was a symbolic link pointing at


@@ -36,6 +44,10 @@ 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.
 
 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>
 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>