]> xenbits.xensource.com Git - people/royger/xen.git/commitdiff
CODING_STYLE: Add a section of the naming convention
authorJulien Grall <jgrall@amazon.com>
Tue, 5 Dec 2023 18:12:18 +0000 (18:12 +0000)
committerJulien Grall <jgrall@amazon.com>
Thu, 7 Dec 2023 15:37:25 +0000 (15:37 +0000)
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>
CODING_STYLE

index ced3ade5a6fb92ba98fe42773608d6cff6360f58..ed13ee2b664b7f9686f9dfa709840147badfe7c8 100644 (file)
@@ -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
 ---------------------