From ff67eea529b450293b19182386b48d317895a414 Mon Sep 17 00:00:00 2001 From: Collin Funk Date: Tue, 3 Jun 2025 15:45:39 -0700 Subject: [PATCH] CodingGuidelines: document formatting of similar config variables. Document that related `git config` variables should be placed one-per-line instead of separated by commas. Suggested-by: Junio C Hamano Signed-off-by: Collin Funk Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index a0e7041c54..129c409a92 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -874,6 +874,17 @@ Markup: 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