Skip to content

Commit

Permalink
CODING_STYLE: Add a section of the naming convention
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
Julien Grall committed Dec 7, 2023
1 parent 2514700 commit d2b7c44
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CODING_STYLE
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------

Expand Down

0 comments on commit d2b7c44

Please sign in to comment.