diff options
| author | Junio C Hamano <gitster@pobox.com> | 2025-06-18 13:53:33 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-06-18 13:53:33 -0700 |
| commit | f1a1d79fcf13c1ab52de01d741767ce42930dbf4 (patch) | |
| tree | 125f02754ad13444dfac5c81abf645f6058c0233 /Documentation/CodingGuidelines | |
| parent | Start 2.51 cycle, the first batch (diff) | |
| parent | CodingGuidelines: document formatting of similar config variables. (diff) | |
| download | git-f1a1d79fcf13c1ab52de01d741767ce42930dbf4.tar.gz git-f1a1d79fcf13c1ab52de01d741767ce42930dbf4.zip | |
Merge branch 'cf/guideline-documenting-config-vars'
CodingGuidelines update.
* cf/guideline-documenting-config-vars:
CodingGuidelines: document formatting of similar config variables.
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 c1046abfb7..88971dea91 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -877,6 +877,17 @@ Characters are also surrounded by underscores: 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 |