From c63e64e04d43ebdc04204a052858c4801c018e1e Mon Sep 17 00:00:00 2001 From: Lucas Seiki Oshiro Date: Wed, 25 Feb 2026 13:32:10 -0300 Subject: [PATCH] CodingGuidelines: instruct to name arrays in singular Arrays should be named in the singular form, ensuring that when accessing an element within an array (e.g. dog[0]) it's clear that we're referring to an element instead of a collection. Add a new rule to CodingGuidelines asking for arrays to be named in singular instead of plural. Helped-by: Eric Sunshine Signed-off-by: Lucas Seiki Oshiro Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index df72fe0177..278083526d 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -656,6 +656,19 @@ For C programs: unsigned other_field:1; unsigned field_with_longer_name:1; + - Array names should be named in the singular form if the individual items are + subject of use. E.g.: + + char *dog[] = ...; + walk_dog(dog[0]); + walk_dog(dog[1]); + + Cases where the array is employed as a whole rather than as its unit parts, + the plural forms is preferable. E.g: + + char *dogs[] = ...; + walk_all_dogs(dogs); + For Perl programs: - Most of the C guidelines above apply.