git-check-ref-format: clarify documentation for --normalize

Use of 'iff' may be confusing to people not familiar with this term.

Improving the --normalize option's documentation to remove the use of
'iff', and clearly describe what happens when the condition is not met.

Signed-off-by: Damien Regad <dregad@mantisbt.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Damien Regad 2017-02-19 23:32:32 +01:00 committed by Junio C Hamano
parent 3b9e3c2ced
commit 115a40add6

View File

@ -100,10 +100,10 @@ OPTIONS
--normalize:: --normalize::
Normalize 'refname' by removing any leading slash (`/`) Normalize 'refname' by removing any leading slash (`/`)
characters and collapsing runs of adjacent slashes between characters and collapsing runs of adjacent slashes between
name components into a single slash. Iff the normalized name components into a single slash. If the normalized
refname is valid then print it to standard output and exit refname is valid then print it to standard output and exit
with a status of 0. (`--print` is a deprecated way to spell with a status of 0, otherwise exit with a non-zero status.
`--normalize`.) (`--print` is a deprecated way to spell `--normalize`.)
EXAMPLES EXAMPLES