Skip to content

Commit c22e5e9

Browse files
committed
Merge branch 'jn/maint-1.6.3-check-ref-format-doc'
* jn/maint-1.6.3-check-ref-format-doc: Documentation: describe check-ref-format --branch
2 parents e38d1c5 + 604e0cb commit c22e5e9

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Documentation/git-check-ref-format.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git check-ref-format' <refname>
12-
'git check-ref-format' [--branch] <branchname-shorthand>
12+
'git check-ref-format' --branch <branchname-shorthand>
1313

1414
DESCRIPTION
1515
-----------
@@ -63,8 +63,11 @@ reference name expressions (see linkgit:git-rev-parse[1]):
6363

6464
. at-open-brace `@{` is used as a notation to access a reflog entry.
6565

66-
With the `--branch` option, it expands a branch name shorthand and
67-
prints the name of the branch the shorthand refers to.
66+
With the `--branch` option, it expands the ``previous branch syntax''
67+
`@{-n}`. For example, `@{-1}` is a way to refer the last branch you
68+
were on. This option should be used by porcelains to accept this
69+
syntax anywhere a branch name is expected, so they can act as if you
70+
typed the branch name.
6871

6972
EXAMPLE
7073
-------

0 commit comments

Comments
 (0)