Added documentation for new clang-tidy settings #5430
Conversation
|
@Omotola : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 7b8f3c1: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
docs/code-quality/clang-tidy.md
Outdated
|
|
||
| ## Max Number of Processes | ||
|
|
||
| The **Max Number of Processes** property lets you specify how many processes Clang-Tidy can use to run analysis in parallel. By default, Clang-Tidy uses a single processor. Set this property to a specific number to limit the number of parallel processes, or set it to `0` to use all available logical processors on your system. Increasing the number of processes can improve analysis speed on multi-core machines. |
There was a problem hiding this comment.
I'm unclear how 'uses a single processor' fits in here. The text seems to say that by default Clang-Tidy uses a single processor, yet you can set the property to a specific number to limit the number of parallel processes. Why would you need to limit it if the default is to run on a single processor?
Maybe the problem here is the difference between a physical processor and logical processes. Would it be correct to instead say something like "Clang-Tidy uses a single processor to run an unlimited number of logical processes in parallel. Set this property to limit the number of processes run in parallel. Set it to 0 to use all available logical processors in your system."
Or is the physical processor a red-herring here? If there are multiple processes, why are they run on a single processor?
At any rate, I'm confused by how a physical processor plays into the logical processors that the property seems to be about.
There was a problem hiding this comment.
I think the wording around "limit the number of parallel processes" is where the confusion is. Clang-tidy runs serially by default and this new setting is to enable users run it in parallel. I used the word "limit" to note that if users don't want to set to '0' to use all available processors they can limit the number of processes instead.
What do you think of this wording instead - "By default, Clang-Tidy runs serially. Set this property to enable parallel execution and specify the number of parallel processes. Set it to 0 to use all available logical processors in your system."
There was a problem hiding this comment.
That sounds great to me.
|
Learn Build status updates of commit 3101e63: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit f82c936: ✅ Validation status: passed
For more details, please refer to the build report. |
|
#sign-off |
Added information for 3 new clang-tidy properties that allow uses to pass extra arguments to the tool and specify number of processes to run.