From d2b7c442b4a066bb670ee83e24800cabc415241d Mon Sep 17 00:00:00 2001 From: Julien Grall Date: Tue, 5 Dec 2023 18:12:18 +0000 Subject: [PATCH] CODING_STYLE: Add a section of the naming convention 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 --- CODING_STYLE | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CODING_STYLE b/CODING_STYLE index ced3ade5a6fb..ed13ee2b664b 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 for files and command line options +---------------------------------------------------- + +'-' 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. + Emacs local variables ---------------------