summaryrefslogtreecommitdiff
path: root/Documentation/git-check-ref-format.txt
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@gmail.com>2009-10-12 05:28:23 (GMT)
committerJunio C Hamano <gitster@pobox.com>2009-10-12 23:28:42 (GMT)
commit604e0cb5cbd2ea2e37273e13f99b6572cd82b4c1 (patch)
tree4692cf04781e1badbce51fe9540269be4bf7524a /Documentation/git-check-ref-format.txt
parentf01f1099f40f24fe6f7802185340a6fa3a3d4f35 (diff)
downloadgit-604e0cb5cbd2ea2e37273e13f99b6572cd82b4c1.zip
git-604e0cb5cbd2ea2e37273e13f99b6572cd82b4c1.tar.gz
git-604e0cb5cbd2ea2e37273e13f99b6572cd82b4c1.tar.bz2
Documentation: describe check-ref-format --branch
Unless one already knew, it was not obvious what sort of shorthand "git check-ref-format --branch" expands. Explain it. The --branch argument is not optional. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-check-ref-format.txt')
-rw-r--r--Documentation/git-check-ref-format.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index c1ce268..664da8a 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'git check-ref-format' <refname>
-'git check-ref-format' [--branch] <branchname-shorthand>
+'git check-ref-format' --branch <branchname-shorthand>
DESCRIPTION
-----------
@@ -57,8 +57,11 @@ reference name expressions (see linkgit:git-rev-parse[1]):
. at-open-brace `@{` is used as a notation to access a reflog entry.
-With the `--branch` option, it expands a branch name shorthand and
-prints the name of the branch the shorthand refers to.
+With the `--branch` option, it expands the ``previous branch syntax''
+`@{-n}`. For example, `@{-1}` is a way to refer the last branch you
+were on. This option should be used by porcelains to accept this
+syntax anywhere a branch name is expected, so they can act as if you
+typed the branch name.
EXAMPLE
-------