diff options
| author | Antonio Borneo <borneo.antonio@gmail.com> | 2023-08-28 12:11:48 +0200 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2023-09-08 21:58:47 +0000 |
| commit | 2839a873a3e93c8f744352fc1671c2db6297937b (patch) | |
| tree | 9347d588f19a652149d286ac42041bda8fed65e3 /doc/manual | |
| parent | 6f986d2cd78e1502e840d7c5f06e67ed8bbc352b (diff) | |
| download | riscv-openocd-2839a873a3e93c8f744352fc1671c2db6297937b.zip riscv-openocd-2839a873a3e93c8f744352fc1671c2db6297937b.tar.gz riscv-openocd-2839a873a3e93c8f744352fc1671c2db6297937b.tar.bz2 | |
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.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/7875
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
Tested-by: jenkins
Diffstat (limited to 'doc/manual')
| -rw-r--r-- | doc/manual/style.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/manual/style.txt b/doc/manual/style.txt index 58f3980..1d3ec67 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. |