[v1] CODING_STYLE: Add a section of the naming convention

[PATCH] CODING_STYLE: Add a section of the naming convention

Julien Grall posted 1 patch 4 months, 3 weeks ago

Diff against v1
Download mbox

Patches applied successfully (tree, apply log)
git fetch https://gitlab.com/xen-project/patchew/xen tags/patchew/20231205181218.74667-1-julien@xen.org

CODING_STYLE | 9 +++++++++
1 file changed, 9 insertions(+)

Expand all Fold all

[PATCH] CODING_STYLE: Add a section of the naming convention

Posted by Julien Grall 4 months, 3 weeks ago

From: Julien Grall <jgrall@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 <jgrall@amazon.com>

---
    Changes in v2:
        - New wording
        - Update the section title
        - Add Jan's acked-by
---
 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
 ---------------------
 
-- 
2.40.1