Merge branch 'js/log-rewrap'
[gitweb.git] / Documentation / git-check-ref-format.txt
index 211ae1c3fadeb4436725a9cce80cd8583fd2a140..0aeef24780f07e5d5fa021f6ebdaa7090a3dcdb7 100644 (file)
@@ -10,7 +10,7 @@ SYNOPSIS
 [verse]
 'git check-ref-format' <refname>
 'git check-ref-format' --print <refname>
-'git check-ref-format' [--branch] <branchname-shorthand>
+'git check-ref-format' --branch <branchname-shorthand>
 
 DESCRIPTION
 -----------
@@ -68,8 +68,11 @@ With the `--print` option, if 'refname' is acceptable, it prints the
 canonicalized name of a hypothetical reference with that name.  That is,
 it prints 'refname' with any extra `/` characters removed.
 
-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.
 
 EXAMPLES
 --------