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

Merge branch 'cf/guideline-documenting-config-vars'

Browse Source 
CodingGuidelines update.

* cf/guideline-documenting-config-vars:
  CodingGuidelines: document formatting of similar config variables.
This commit is contained in:
Junio C Hamano
2025-06-18 13:53:33 -07:00
parent f9aa0eedb3 ff67eea529
commit f1a1d79fcf
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

@@ -877,6 +877,17 @@ Characters are also surrounded by underscores:
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