Re: [PATCH v2 01/35] CodingGuidelines: update and clarify command-line conventions

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 28, 2022, 17:29 UTC
Message-ID: <xmqqpmffv24a.fsf@gitster.g>
In-Reply-To: <patch-v2-01.35-aecd3ff41f2-20220928T082458Z-avarab@gmail.com>

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

Show 5 quoted lines

>   Optional parts are enclosed in square brackets:
> -   [<extra>]
> -   (Zero or one <extra>.)
> +   [<file>...]
> +   (Zero or more of <file>.)

OK.

Show 10 quoted lines

> + Use spacing around "|" token(s), but not immediately after opening or
> + before closing a [] or () pair:
> +   Do: [-q | --quiet]
> +   Don't: [-q|--quiet]
> +
> + Don't use spacing around "|" tokens when they're used to seperate the
> + alternate arguments of an option:
> +    Do: --track[=(direct|inherit)]
> +    Don't: --track[=(direct | inherit)]
> +

Hmph, that sounds inconsistent; I would have expected the same use (or omission) of space around the vertical bar. But if that is the prevailing style, I won't complain about writing it down.

Thanks.