admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CodingGuidelines: document formatting of similar config variables.

Browse Source 
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>
This commit is contained in:
Collin Funk
2025-06-03 15:45:39 -07:00
committed by Junio C Hamano
parent d50a5e8939
commit ff67eea529
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/CodingGuidelines
View File

@@ -874,6 +874,17 @@ Markup:
As a side effect, backquoted placeholders are correctly typeset, but As a side effect, backquoted placeholders are correctly typeset, but
this style is not recommended. 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 Synopsis Syntax
The synopsis (a paragraph with [synopsis] attribute) is automatically The synopsis (a paragraph with [synopsis] attribute) is automatically