This is an automated email from Gerrit.
"Antonio Borneo <borneo.anto...@gmail.com>" just uploaded a new patch set to
Gerrit, which you can find at https://review.openocd.org/c/openocd/+/7875
-- gerrit
commit b09054667b324723f136bc12ef63a186f68f36b3
Author: Antonio Borneo <borneo.anto...@gmail.com>
Date: Mon Aug 28 12:11:48 2023 +0200
doc/style: clarify default case for enumerators
Enumerator's case were not specified in the coding style.
Add enumerators together with macros for upper-case preference.
While there, add the word CamelCase beside the less common, but
already used, MixedCaps. This could help linking this chapter to
the output of checkpatch script.
Change-Id: I6d4af06cc6f4bc46f525e99e9a74ecc167606c49
Signed-off-by: Antonio Borneo <borneo.anto...@gmail.com>
diff --git a/doc/manual/style.txt b/doc/manual/style.txt
index 58f39807e2..1d3ec6748d 100644
--- a/doc/manual/style.txt
+++ b/doc/manual/style.txt
@@ -111,8 +111,8 @@ Finally, try to avoid lines of code that are longer than
72-80 columns:
@section stylenames Naming Rules
- most identifiers must use lower-case letters (and digits) only.
- - macros must use upper-case letters (and digits) only.
- - OpenOCD identifiers should NEVER use @c MixedCaps.
+ - macros and enumerators must use upper-case letters (and digits) only.
+ - OpenOCD identifiers should NEVER use @c MixedCaps, aka @c CamelCase.
- @c typedef names must end with the '_t' suffix.
- This should be reserved for types that should be passed by value.
- Do @b not mix the typedef keyword with @c struct.
--
