diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2018-06-12 08:02:14 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2018-06-12 08:02:20 -0400 |
| commit | b22115d9a3b0ab5ce35efbfee95d87cb44b3df54 (patch) | |
| tree | f16cddd80b2c46c1f5d2f66660a38596b61b2939 /doc | |
| parent | 7c32b414b6325743c99fed1208bc53ab0fa1996f (diff) | |
| parent | e56771365b446fa7f51a17d67f3fbe560baaa5a5 (diff) | |
Merge #13312: docs: Add a note about the source code filename naming convention
e56771365b Do not use uppercase characters in source code filenames (practicalswift)
419a1983ca docs: Add a note about the source code filename naming convention (practicalswift)
Pull request description:
Add a note about the source code filename naming convention.
Tree-SHA512: 8d329bd9e19bcd26e74b0862fb0bc2369b46095dbd3e69d34859908632763abd7c3d00ccc44ee059772ad4bae4460c2bcc1c0e22fd9d8876d57e5fcd346cea4b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 4821a59f19..2fa91ecb02 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -595,6 +595,12 @@ Source code organization - *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time +- Use only the lowercase alphanumerics (`a-z0-9`), underscore (`_`) and hyphen (`-`) in source code filenames. + + - *Rationale*: `grep`:ing and auto-completing filenames is easier when using a consistent + naming pattern. Potential problems when building on case-insensitive filesystems are + avoided when using only lowercase characters in source code filenames. + - Every `.cpp` and `.h` file should `#include` every header file it directly uses classes, functions or other definitions from, even if those headers are already included indirectly through other headers. |