On 01/12/2023 18:47, Julien Grall wrote:
From: Julien Grall <jgr...@amazon.com>
Several maintainers have expressed a stronger preference
to use '-' when in filename and option that contains multiple
words.
So document it in CODING_STYLE.
Signed-off-by: Julien Grall <jgr...@amazon.com>
---
CODING_STYLE | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/CODING_STYLE b/CODING_STYLE
index ced3ade5a6fb..afd09177745b 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -144,6 +144,15 @@ separate lines and each line should begin with a leading
'*'.
* Note beginning and end markers on separate lines and leading '*'.
*/
+Naming convention
+-----------------
+
+When command line option or filename contain multiple words, a '-'
+should be to separate them. E.g. 'timer-works'.
+
+Note that some of the option and filename are using '_'. This is now
+deprecated.
Urgh, I sent the wrong draft :(. This is the wording I wanted to propose:
+Naming convention
+-----------------
+
+'-' should be used to separate words in commandline options and filenames.
+E.g. timer-works.
+
+Note that some of the options and filenames are using '_'. This is now
+deprecated.
+
Cheers,
--
Julien Grall
