Skip to content

Commit adad2ef

Browse files
authored
Merge pull request #307 from vkucera/naming
Update clang-tidy instructions: Remove include sorting. Add naming conventions.
2 parents be271a1 + fc94086 commit adad2ef

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

docs/tools/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,15 @@ Next time you execute `git commit`, the hooks will run automatically.
6060

6161
### Tips
6262

63+
#### Naming conventions
64+
65+
The [`readability-identifier-naming`](https://clang.llvm.org/extra/clang-tidy/checks/readability/identifier-naming.html) check can fix deviations from the [naming conventions](https://rawgit.com/AliceO2Group/CodingGuidelines/master/naming_formatting.html).
66+
6367
#### Cleaning `#include`s
6468

6569
The [`misc-include-cleaner`](https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html) check can fix missing and unused `#include`s.
6670
This helps to apply the [Include What You Use](https://github.com/AliceO2Group/O2Physics/issues/8357) principle which allows to maintain header dependencies clean.
6771

68-
#### Sorting `#include`s
69-
70-
The [`llvm-include-order`](https://clang.llvm.org/extra/clang-tidy/checks/llvm/include-order.html) check sorts `#include`s from most specific to least specific to ensure that the headers do not have any hidden dependencies.
71-
72-
Unfortunately, the [LLVM include style](https://llvm.org/docs/CodingStandards.html#include-style) is incompatible with the [Google include style](https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes) applied by `cpplint`.
73-
7472
#### Testing (and fixing) many files at once
7573

7674
Here is an example of how to run the `misc-include-cleaner` check in parallel on all `.h` and `.cxx` files in the current directory.

0 commit comments

Comments
 (0)