[OpenOCD-commit] Main OpenOCD repository branch, master, updated. v0.12.0-311-g2839a873a

[openocd-gerrit <ope...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Main OpenOCD repository".

The branch, master has been updated
       via  2839a873a3e93c8f744352fc1671c2db6297937b (commit)
      from  6f986d2cd78e1502e840d7c5f06e67ed8bbc352b (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 2839a873a3e93c8f744352fc1671c2db6297937b
Author: Antonio Borneo <bor...@gm...>
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 <bor...@gm...>
    Reviewed-on: https://review.openocd.org/c/openocd/+/7875
    Reviewed-by: Tomas Vanek <va...@fb...>
    Tested-by: jenkins

diff --git a/doc/manual/style.txt b/doc/manual/style.txt
index 58f39807e..1d3ec6748 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.

-----------------------------------------------------------------------

Summary of changes:
 doc/manual/style.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


hooks/post-receive
-- 
Main OpenOCD repository