summaryrefslogtreecommitdiff
path: root/Documentation/git-symbolic-ref.txt
diff options
context:
space:
mode:
authorJohan Herland <johan@herland.net>2012-10-21 11:32:33 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-10-21 19:17:38 (GMT)
commit9ab55daa55377fa258c18ffb90211547e299eec9 (patch)
tree1c3d17bf9f00b92de5c1c09d8056114f6f964387 /Documentation/git-symbolic-ref.txt
parent87a5461fa7b30f7b7baf27204f10219d61500fbf (diff)
downloadgit-9ab55daa55377fa258c18ffb90211547e299eec9.zip
git-9ab55daa55377fa258c18ffb90211547e299eec9.tar.gz
git-9ab55daa55377fa258c18ffb90211547e299eec9.tar.bz2
git symbolic-ref --delete $symref
Teach symbolic-ref to delete symrefs by adding the -d/--delete option to git-symbolic-ref. Both proper and dangling symrefs are deleted by this option, but other refs - or anything else that is not a symref - is not. The symref deletion is performed by first verifying that we are given a proper symref, and then invoking delete_ref() on it with the REF_NODEREF flag. Signed-off-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-symbolic-ref.txt')
-rw-r--r--Documentation/git-symbolic-ref.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 981d3a8..ef68ad2 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -3,13 +3,14 @@ git-symbolic-ref(1)
NAME
----
-git-symbolic-ref - Read and modify symbolic refs
+git-symbolic-ref - Read, modify and delete symbolic refs
SYNOPSIS
--------
[verse]
'git symbolic-ref' [-m <reason>] <name> <ref>
'git symbolic-ref' [-q] [--short] <name>
+'git symbolic-ref' --delete [-q] <name>
DESCRIPTION
-----------
@@ -21,6 +22,9 @@ argument to see which branch your working tree is on.
Given two arguments, creates or updates a symbolic ref <name> to
point at the given branch <ref>.
+Given `--delete` and an additional argument, deletes the given
+symbolic ref.
+
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`.
@@ -28,6 +32,10 @@ a regular file whose contents is `ref: refs/heads/master`.
OPTIONS
-------
+-d::
+--delete::
+ Delete the symbolic ref <name>.
+
-q::
--quiet::
Do not issue an error message if the <name> is not a