check-ref-format doc: --branch validates and expands <branch>
commit89dd32aedcb52a77240f3923a687edc8a61662e7
authorJunio C Hamano <gitster@pobox.com>
Tue, 17 Oct 2017 07:12:34 +0000 (17 00:12 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 17 Oct 2017 23:01:48 +0000 (18 08:01 +0900)
tree99ebdc9614b4054a6d7d05321eeacb1804d52eee
parent7ccc94ff4590cd035b7f78dfd9debbd7e692f3e6
check-ref-format doc: --branch validates and expands <branch>

"git check-ref-format --branch $name" feature was originally
introduced (and was advertised) as a way for scripts to take any
end-user supplied string (like "master", "@{-1}" etc.) and see if it
is usable when Git expects to see a branch name, and also obtain the
concrete branch name that the at-mark magic expands to.

Emphasize that "see if it is usable" role in the description and
clarify that the @{...} expansion only occurs when run from within a
repository.

[jn: split out from a larger patch]

Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-check-ref-format.txt