]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
Document the plan of changing naming conventions for namespaces
authorJoel Rosdahl <joel@rosdahl.net>
Tue, 15 Jun 2021 19:02:29 +0000 (21:02 +0200)
committerJoel Rosdahl <joel@rosdahl.net>
Tue, 15 Jun 2021 19:08:08 +0000 (21:08 +0200)
Namespaces are from now on planned to be in snake_case instead of
UpperCamelCase. This is of course entirely due to cosmetical reasons,
but I feel that it maps better to the upcoming changes in directory
structure where I don’t want camel-case directory names.

CONTRIBUTING.md

index 3a845c8790abfd419958f73d32b2504e3440b173..043f9141a51c42a68023d1092c174adc9b9225ed 100644 (file)
@@ -61,10 +61,11 @@ fine.
 
 Please follow these conventions:
 
-* Use `UpperCamelCase` for types (e.g. classes and structs) and namespaces.
-* Use `UPPER_CASE` names for macros and (non-class )enum values.
-* Use `snake_case` for other names (functions, variables, enum class values,
-  etc.).
+* Use `UpperCamelCase` for types (e.g. classes and structs).
+* Use `UPPER_CASE` names for macros and (non-class) enum values.
+* Use `snake_case` for other names (namespaces, functions, variables, enum class
+  values, etc.). (Namespaces used to be in `UpperCamelCase`; transition is work
+  in progress.)
 * Use an `m_` prefix for non-public member variables.
 * Use a `g_` prefix for global mutable variables.
 * Use a `k_` prefix for global constants.