git-check-ref-format: clarify documentation for --normalize
authorDamien Regad <dregad@mantisbt.org>
Sun, 19 Feb 2017 22:32:32 +0000 (23:32 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 21 Feb 2017 21:02:42 +0000 (13:02 -0800)
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>
Documentation/git-check-ref-format.txt
index 8611a99120eb1c7070b64f80b39b1526225a8019..92777cef25e1145fc2a060d572255be564dec491 100644 (file)
@@ -100,10 +100,10 @@ OPTIONS
 --normalize::
        Normalize 'refname' by removing any leading slash (`/`)
        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
-       with a status of 0.  (`--print` is a deprecated way to spell
-       `--normalize`.)
+       with a status of 0, otherwise exit with a non-zero status.
+       (`--print` is a deprecated way to spell `--normalize`.)
 
 
 EXAMPLES