diff options
Diffstat (limited to 'Documentation/git-symbolic-ref.txt')
| -rw-r--r-- | Documentation/git-symbolic-ref.txt | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt index 4bc35a1d4b..f93b79a85e 100644 --- a/Documentation/git-symbolic-ref.txt +++ b/Documentation/git-symbolic-ref.txt @@ -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' <name> [<ref>] +'git-symbolic-ref' [-q] <name> [<ref>] 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`. +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 @@ -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. +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> |