Skip to content

Commit 1c3769c

Browse files
committed
Tools: Fix program names
1 parent 624a83b commit 1c3769c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/tools/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ Next time you execute `git commit`, the hooks will run automatically.
4848
- If the cpplint hook fails, the linter has found issues that need to be fixed.
4949
- Updated files need to be staged with `git add` before attempting `git commit` again.
5050

51-
## [clang-tidy](https://clang.llvm.org/extra/clang-tidy/)
51+
## [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/)
5252

53-
`clang-tidy` is a clang-based C++ linter tool for diagnosing and fixing typical programming errors, like style violations or bugs.
53+
Clang-Tidy is a clang-based C++ linter tool for diagnosing and fixing typical programming errors, like style violations or bugs.
5454
(See the [list of checks](https://clang.llvm.org/extra/clang-tidy/checks/list.html).)
5555

56-
To use `clang-tidy`, you need to have O2Physics compiled and a valid symbolic link `compile_commands.json` in the O2Physics directory pointing to the `alice/sw/BUILD/.../O2Physics` directory.
56+
To use Clang-Tidy, you need to have O2Physics compiled and a valid symbolic link `compile_commands.json` in the O2Physics directory pointing to the `alice/sw/BUILD/.../O2Physics` directory.
5757

5858
### Checking naming conventions
5959

@@ -74,9 +74,9 @@ find . -name "*.h" -o -name "*.cxx" -o -name "*.C" | parallel "clang-tidy --fix
7474

7575
The [`parallel`](https://www.gnu.org/software/parallel/) command is used to parallelise the execution of the `clang-tidy` command for all files.
7676

77-
For each file, `clang-tidy` will first try to compile it and then run the enabled check(s) and fix found problems (the `--fix` option).
77+
For each file, Clang-Tidy will first try to compile it and then run the enabled check(s) and fix found problems (the `--fix` option).
7878
The messages are redirected into `clang-tidy.log`.
79-
The file name and the exit code are printed below the output of `clang-tidy` so that you can get the list of files for which `clang-tidy` failed with `grep " 1$" "clang-tidy.log"`.
79+
The file name and the exit code are printed below the output of Clang-Tidy so that you can get the list of files for which Clang-Tidy failed with `grep " 1$" "clang-tidy.log"`.
8080

8181
## Fixing include format
8282

@@ -92,14 +92,14 @@ To fix the include format in all `.h`, `.cxx` files in the current directory, ex
9292
find . -name "*.h" -o -name "*.cxx" | parallel "awk -f Scripts/format_includes.awk \"{}\" > \"{}.tmp\" && mv \"{}.tmp\" \"{}\""
9393
```
9494

95-
## [cppcheck](https://cppcheck.sourceforge.io/)
95+
## [Cppcheck](https://cppcheck.sourceforge.io/)
9696

97-
`cppcheck` is a static analysis tool for C/C++ code that detects bugs, undefined behaviour, and dangerous coding constructs that compilers typically miss.
97+
Cppcheck is a static analysis tool for C/C++ code that detects bugs, undefined behaviour, and dangerous coding constructs that compilers typically miss.
9898

99-
`cppcheck` can analyse individual files (file mode) or entire projects (project mode).
99+
Cppcheck can analyse individual files (file mode) or entire projects (project mode).
100100
The two modes give slightly different results so one can consider using both for maximum coverage.
101101

102-
### Using cppcheck in file mode
102+
### Using Cppcheck in file mode
103103

104104
The file mode is used in the MegaLinter check on GitHub.
105105

@@ -119,7 +119,7 @@ find . -name "*.h" -o -name "*.cxx" -o -name "*.C" | parallel "cppcheck --langua
119119

120120
Note: It is possible to parallelise the execution with the `-j` option instead but it usually produces less results than analysing files independently.
121121

122-
### Using cppcheck in project mode
122+
### Using Cppcheck in project mode
123123

124124
To use this mode, you need to have O2Physics compiled and a valid symbolic link `compile_commands.json` in the O2Physics directory pointing to the `alice/sw/BUILD/.../O2Physics` directory.
125125

@@ -131,7 +131,7 @@ cppcheck --language=c++ --std=c++20 --enable=style --check-level=exhaustive --su
131131

132132
### Generating browsable HTML output
133133

134-
Run `cppcheck` with the additional option `--xml` which will store the output in the XML format.
134+
Run Cppcheck with the additional option `--xml` which will store the output in the XML format.
135135

136136
If you used the file mode, the output file will contain an XML header and a footer for each analysed file which makes the output file invalid.
137137
To keep only the first header and the last footer, you can extract the relevant parts of the file with:

0 commit comments

Comments
 (0)