felix642 created this revision.
Herald added subscribers: PiotrZSL, carlosgalvezp, xazax.hun.
Herald added a reviewer: njames93.
Herald added a project: All.
felix642 requested review of this revision.
Herald added a project: clang-tools-extra.
Herald added a subscriber: cfe-commits.
The documentation would say that that default value for most parameters is -1.
But since the parameter used in clang-tidy is an unsigned the value would get
implicitly converted to 4294967295.
If a user tried to use -1 to disable this check he would receive an error
saying that
the parameter is invalid.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D159045
Files:
clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
Index: clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
+++ clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
@@ -12,8 +12,8 @@
.. option:: LineThreshold
- Flag functions exceeding this number of lines. The default is `-1` (ignore
- the number of lines).
+ Flag functions exceeding this number of lines. This option is disabled by
+ default.
.. option:: StatementThreshold
@@ -23,23 +23,23 @@
.. option:: BranchThreshold
- Flag functions exceeding this number of control statements. The default is
- `-1` (ignore the number of branches).
+ Flag functions exceeding this number of control statements. This option is
+ disabled by default.
.. option:: ParameterThreshold
- Flag functions that exceed a specified number of parameters. The default
- is `-1` (ignore the number of parameters).
+ Flag functions that exceed a specified number of parameters. This option
+ is disabled by default.
.. option:: NestingThreshold
Flag compound statements which create next nesting level after
`NestingThreshold`. This may differ significantly from the expected value
- for macro-heavy code. The default is `-1` (ignore the nesting level).
+ for macro-heavy code. This option is disabled by default.
.. option:: VariableThreshold
Flag functions exceeding this number of variables declared in the body.
- The default is `-1` (ignore the number of variables).
Please note that function parameters and variables declared in lambdas,
- GNU Statement Expressions, and nested class inline functions are not
counted.
+ GNU Statement Expressions, and nested class inline functions are not
+ counted. This option is disabled by default.
Index: clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
+++ clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
@@ -12,8 +12,8 @@
.. option:: LineThreshold
- Flag functions exceeding this number of lines. The default is `-1` (ignore
- the number of lines).
+ Flag functions exceeding this number of lines. This option is disabled by
+ default.
.. option:: StatementThreshold
@@ -23,23 +23,23 @@
.. option:: BranchThreshold
- Flag functions exceeding this number of control statements. The default is
- `-1` (ignore the number of branches).
+ Flag functions exceeding this number of control statements. This option is
+ disabled by default.
.. option:: ParameterThreshold
- Flag functions that exceed a specified number of parameters. The default
- is `-1` (ignore the number of parameters).
+ Flag functions that exceed a specified number of parameters. This option
+ is disabled by default.
.. option:: NestingThreshold
Flag compound statements which create next nesting level after
`NestingThreshold`. This may differ significantly from the expected value
- for macro-heavy code. The default is `-1` (ignore the nesting level).
+ for macro-heavy code. This option is disabled by default.
.. option:: VariableThreshold
Flag functions exceeding this number of variables declared in the body.
- The default is `-1` (ignore the number of variables).
Please note that function parameters and variables declared in lambdas,
- GNU Statement Expressions, and nested class inline functions are not counted.
+ GNU Statement Expressions, and nested class inline functions are not
+ counted. This option is disabled by default.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
