[PATCH] D159436: [clang-tidy] Add support for optional parameters in config.

[Piotr Zegar via Phabricator via cfe-commits]

PiotrZSL accepted this revision.
PiotrZSL added a comment.
This revision is now accepted and ready to land.

Except few nits in documentation looks fine. Probably one day in future we can add same for bools.
Make sure that documentation of impacted checks is correct, so it says that argument is positive integer, or none to force default value.



================
Comment at: clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h:20-34
+///   * `LineThreshold` - flag functions exceeding this number of lines. This
+///     parameter is disabled by default.
 ///   * `StatementThreshold` - flag functions exceeding this number of
 ///     statements. This may differ significantly from the number of lines for
 ///     macro-heavy code. The default is `800`.
 ///   * `BranchThreshold` - flag functions exceeding this number of control
+///     statements. This parameter is disabled by default.
----------------
Those options documentation could be removed from this file. Only keep check description.


================
Comment at: clang-tools-extra/docs/ReleaseNotes.rst:116-118
+- Added support for optional parameters. Parameters that previously used -1 to disable
+  their effect can now be set to `none`, `null`, or left empty to get the same
+  behaviour.
----------------
I'm not sure if this release notes entry is needed. Maybe this change should be documented per changed check basic.


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst:15
 
-   Flag functions exceeding this number of lines. The default is `-1` (ignore
-   the number of lines).
+   Flag functions exceeding this number of lines. This parameter is disabled
+   by default.
----------------
Leave previous but change -1 into none.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D159436/new/

https://reviews.llvm.org/D159436