diff options
| author | Collin Funk <collin.funk1@gmail.com> | 2025-06-03 15:45:39 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-06-18 13:48:11 -0700 |
| commit | ff67eea529b450293b19182386b48d317895a414 (patch) | |
| tree | 241f8b9d6db8b6664e43407d6bc0e77ef3166b01 /Documentation/CodingGuidelines | |
| parent | d50a5e8939abfc07c2ff97ae72e9330939b36ee0 (diff) | |
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 <gitster@pobox.com>
Signed-off-by: Collin Funk <collin.funk1@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 11 |
1 files changed, 11 insertions, 0 deletions
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 |