summaryrefslogtreecommitdiff
path: root/Documentation/git-symbolic-ref.txt
diff options
context:
space:
mode:
authorJan Krüger <jk@jk.gs>2012-02-27 22:10:38 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-02-27 23:58:36 (GMT)
commit42b00599be684e20462c431a718f86c2b6fce575 (patch)
tree81d9579d42fbc12ea8dd3013f24319b6bce17531 /Documentation/git-symbolic-ref.txt
parent3724cc7c58df709cffbf6cc0701d1ca6fa5a5ba2 (diff)
downloadgit-42b00599be684e20462c431a718f86c2b6fce575.zip
git-42b00599be684e20462c431a718f86c2b6fce575.tar.gz
git-42b00599be684e20462c431a718f86c2b6fce575.tar.bz2
symbolic-ref --short: abbreviate the output unambiguously
It can be helpful to resolve a symbolic ref and output the result in a shortened form, such as for use in shell prompts. Add a "--short" option to do so. Signed-off-by: Jan Krüger <jk@jk.gs> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-symbolic-ref.txt')
-rw-r--r--Documentation/git-symbolic-ref.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index a45d4c4..981d3a8 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -8,7 +8,8 @@ git-symbolic-ref - Read and modify symbolic refs
SYNOPSIS
--------
[verse]
-'git symbolic-ref' [-q] [-m <reason>] <name> [<ref>]
+'git symbolic-ref' [-m <reason>] <name> <ref>
+'git symbolic-ref' [-q] [--short] <name>
DESCRIPTION
-----------
@@ -33,6 +34,10 @@ OPTIONS
symbolic ref but a detached HEAD; instead exit with
non-zero status silently.
+--short::
+ When showing the value of <name> as a symbolic ref, try to shorten the
+ value, e.g. from `refs/heads/master` to `master`.
+
-m::
Update the reflog for <name> with <reason>. This is valid only
when creating or updating a symbolic ref.