summaryrefslogtreecommitdiff
path: root/Documentation/git-check-ref-format.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2009-10-24 05:30:20 (GMT)
committerJunio C Hamano <gitster@pobox.com>2009-10-24 05:30:20 (GMT)
commit64fb90b7076eda54d894484ce34a91632997cd2b (patch)
tree7e69f084068a2dfb380ee49fb15ec3131d7b7b97 /Documentation/git-check-ref-format.txt
parent70ed433c2b66d192b84d4a1ef7fb193ea35e0a28 (diff)
parent604e0cb5cbd2ea2e37273e13f99b6572cd82b4c1 (diff)
downloadgit-64fb90b7076eda54d894484ce34a91632997cd2b.zip
git-64fb90b7076eda54d894484ce34a91632997cd2b.tar.gz
git-64fb90b7076eda54d894484ce34a91632997cd2b.tar.bz2
Merge branch 'jn/maint-1.6.3-check-ref-format-doc' into maint
* jn/maint-1.6.3-check-ref-format-doc: Documentation: describe check-ref-format --branch
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 0b7982e..e9b3b40 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
-----------
@@ -63,8 +63,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
-------