Skip to content

Commit ff67eea

Browse files
collinfunkgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Collin Funk <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d50a5e8 commit ff67eea

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,17 @@ Markup:
874874
As a side effect, backquoted placeholders are correctly typeset, but
875875
this style is not recommended.
876876

877+
When documenting multiple related `git config` variables, place them on
878+
a separate line instead of separating them by commas. For example, do
879+
not write this:
880+
`core.var1`, `core.var2`::
881+
Description common to `core.var1` and `core.var2`.
882+
883+
Instead write this:
884+
`core.var1`::
885+
`core.var2`::
886+
Description common to `core.var1` and `core.var2`.
887+
877888
Synopsis Syntax
878889

879890
The synopsis (a paragraph with [synopsis] attribute) is automatically

0 commit comments

Comments
 (0)