Recently, I ran clang-tidy in my system and had to figure out setting it up correcty on my system (macOS) & understanding its output while tweaking few arguments that made the output easier to parse.
This patch documents those in the developer notes.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--021abf342d371248e50ceaed478a90ca-->
See the guideline for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | sedited |
If your review is incorrectly listed, please copy-paste <code><!--meta-tag:bot-skip--></code> into the comment that the bot should ignore.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
176 | -To run clang-tidy on all source files: 177 | +To run clang-tidy on all source files using the checks mentioned in the `./src/.clang-tidy` file: 178 | 179 | ```sh 180 | -( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) ) 181 | +( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) && cd .. )
The second cd seems redundant?
I want it to go back to the root directory automatically after clang-tidy is done.
Yes, this is what happens when the inner Bash exits:
$ echo $PWD && ( cd folder && echo $PWD ) && echo $PWD
/tmp
/tmp/folder
/tmp
There is no need for a manual cd
Ah, I forgot adding the parentheses - I'll remove the cd.
179 | ```sh 180 | -( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) ) 181 | +( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) && cd .. ) 182 | ``` 183 | 184 | +Optionally, append the `run-clang-tidy` command with the `-quiet` option to suppress printing of statistics and ignored warnings that can clutter the output.
There is also the -fix option, which sometimes comes in handy
Added a sentence.
182 | ``` 183 | 184 | +Optionally, append the `run-clang-tidy` command with the `-quiet` option to suppress printing of statistics and ignored warnings that can clutter the output. 185 | + 186 | To run clang-tidy on the changed source lines: 187 |
fwiw, to run it on a single file: clang-tidy -p=./build/ src/single_file.cpp
Added a block for this as I used it frequently earlier.
lgtm, but the cd seems odd?
Recently, I ran clang-tidy in my system and had to figure out setting it up
correcty on my system (macOS) & understanding its output while tweaking
few arguments that made the output easier to parse.
This patch documents those in the developer notes.
ACK a1e534bbf076389321a7b0972451671b83b758e8
post-merge code review ACK a1e534bbf076389321a7b0972451671b83b758e8