Re: [PATCH v2] CodingGuidelines: document formatting of similar config variables.
Collin Funk <collin.funk1@gmail.com> writes:
Show 8 quoted lines
> Document that related `git config` variables should be placed
> one-per-line instead of separated by commas.
>
> Suggested-by: Junio C Hamano <gitster@pobox.com>
> Signed-off-by: Collin Funk <collin.funk1@gmail.com>
> ---
> Documentation/CodingGuidelines | 11 +++++++++++
> 1 file changed, 11 insertions(+)
Show 22 quoted lines
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index c1046abfb7..3dd339f802 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -877,6 +877,17 @@ Characters are also surrounded by underscores:
> As a side effect, backquoted placeholders are correctly typeset, but
> this style is not recommended.
>
> + When documenting multiple related `git config` variables, place them on
> + a separate line instead of separating them by commas. For example, do
> + not write this:
> + `core.var1`, `core.var2`::
> + Description common to `core.var1` and `core.var2`.
> +
> +Instead write this:
> + `core.var1`::
> + `core.var2`::
> + Description common to `core.var1` and `core.var2`.
> +
> Synopsis Syntax
>
> The synopsis (a paragraph with [synopsis] attribute) is automatically
Junio C Hamano <gitster@pobox.com>