[PATCH] CodingGuidelines: document formatting required by generate-configlist.sh.
- From
Collin Funk <collin.funk1@gmail.com>
- Date
- Jun 3, 2025, 00:49 UTC
- Message-ID
- <45c586122afab8ae3624be6963d64e770b7396b2.1748911713.git.collin.funk1@gmail.com>
- In-Reply-To
- <xmqqplflsmic.fsf@gitster.g>
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> --- Documentation/CodingGuidelines | 9 +++++++++ 1 file changed, 9 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index c1046abfb7..3a7e644acf 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -877,6 +877,15 @@ 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: + core.var1:: + core.var2:: + This is a description of 'core.var1' and 'core.var2'. + +This format is required for the `generate-configlist.sh` script to +properly generate "config-list.h". + Synopsis Syntax The synopsis (a paragraph with [synopsis] attribute) is automatically
-- 2.49.0