diff options
| author | Junio C Hamano <gitster@pobox.com> | 2017-11-15 12:04:57 +0900 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-11-15 12:04:57 +0900 |
| commit | 3be9ac7e56d4bb4ae805543a91de5987e148b661 (patch) | |
| tree | b0ea94ad987a76b159765993d5a70326a4732136 /Documentation | |
| parent | 2e138796d82794f5bb2bccee8680b10346953518 (diff) | |
| parent | 89dd32aedcb52a77240f3923a687edc8a61662e7 (diff) | |
| download | git-3be9ac7e56d4bb4ae805543a91de5987e148b661.tar.gz | |
Merge branch 'jc/check-ref-format-oor' into maint
"git check-ref-format --branch @{-1}" bit a "BUG()" when run
outside a repository for obvious reasons; clarify the documentation
and make sure we do not even try to expand the at-mark magic in
such a case, but still call the validation logic for branch names.
* jc/check-ref-format-oor:
check-ref-format doc: --branch validates and expands <branch>
check-ref-format --branch: strip refs/heads/ using skip_prefix
check-ref-format --branch: do not expand @{...} outside repository
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-check-ref-format.txt | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index 92777cef25..cf0a0b7df2 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -77,7 +77,14 @@ reference name expressions (see linkgit:gitrevisions[7]): . at-open-brace `@{` is used as a notation to access a reflog entry. -With the `--branch` option, it expands the ``previous branch syntax'' +With the `--branch` option, the command takes a name and checks if +it can be used as a valid branch name (e.g. when creating a new +branch). The rule `git check-ref-format --branch $name` implements +may be stricter than what `git check-ref-format refs/heads/$name` +says (e.g. a dash may appear at the beginning of a ref component, +but it is explicitly forbidden at the beginning of a branch name). +When run with `--branch` option in a repository, the input is first +expanded for 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 |