[PATCH v2] git-check-ref-format: clarify man 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. --- Documentation/git-check-ref-format.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index 8611a99..92777ce 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -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 -- 2.7.4
Re: [PATCH v2] git-check-ref-format: clarify man for --normalize
On Sun, Feb 19, 2017 at 11:32:32PM +0100, Damien Regad wrote: > 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. Looks good to me. Thanks for following up. -Peff
Re: [PATCH v2] git-check-ref-format: clarify man for --normalize
Jeff King writes: > On Sun, Feb 19, 2017 at 11:32:32PM +0100, Damien Regad wrote: > >> 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. > > Looks good to me. Thanks for following up. Looks good except that there does not seem to be sign-off. Damien, no need to resend the patch but I need to hear you say that you have read Documentation/SubmittingPatches and you want your sign-off added. Thanks.
