[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen master] CODING_STYLE: Add a section of the naming convention



commit d2b7c442b4a066bb670ee83e24800cabc415241d
Author:     Julien Grall <jgrall@xxxxxxxxxx>
AuthorDate: Tue Dec 5 18:12:18 2023 +0000
Commit:     Julien Grall <jgrall@xxxxxxxxxx>
CommitDate: Thu Dec 7 15:37:25 2023 +0000

    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 <jgrall@xxxxxxxxxx>
---
 CODING_STYLE | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/CODING_STYLE b/CODING_STYLE
index ced3ade5a6..ed13ee2b66 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
 ---------------------
 
--
generated by git-patchbot for /home/xen/git/xen.git#master



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.