File tree Expand file tree Collapse file tree 2 files changed +40
-0
lines changed Expand file tree Collapse file tree 2 files changed +40
-0
lines changed Original file line number Diff line number Diff line change @@ -110,6 +110,18 @@ a tool selected for performing check. Possible values described in
110110
111111Example: ``pio check --fail-on-defect=low --fail-on-defect=medium ``
112112
113+ .. option ::
114+ --skip-packages
115+
116+ Exclude underlying third-party packages from the checking process. By default, PlatformIO
117+ passes frameworks and toolchains include paths required by internal analysis tools to
118+ properly analyze project sources. Some of the supported analysis tools use their own
119+ preprocessor which may fail to parse perfectly valid code and thus provide empty or
120+ partial check reports. This option is useful when developers have no control over this
121+ third-party code and want to perform analysis at least on project sources.
122+
123+ Example: ``pio check --skip-packages ``
124+
113125.. option ::
114126 -s, --silent
115127
Original file line number Diff line number Diff line change @@ -117,3 +117,31 @@ Another option for filtering source files is :option:`pio check --severity` comm
117117 platform = ...
118118 board = ...
119119 check_severity = medium, high
120+
121+
122+ .. _projectconf_check_skip_packages :
123+
124+ ``check_skip_packages ``
125+ ^^^^^^^^^^^^^^^^^^^^^^^
126+
127+ Type: ``Bool (yes or no) `` | Multiple: ``No `` | Default: ``no ``
128+
129+ Exclude underlying third-party packages from the checking process. By default, PlatformIO
130+ passes frameworks and toolchains include paths required by internal analysis tools to
131+ properly analyze project sources. Some of the supported analysis tools use their own
132+ preprocessor which may fail to parse perfectly valid code and thus provide empty or
133+ partial check reports. This option is useful when developers have no control over this
134+ third-party code and want to perform analysis at least on project sources.
135+
136+ Another option for excluding third-party packages is :option: `pio check --skip-packages `
137+ command.
138+
139+ **Example **
140+
141+ .. code-block :: ini
142+
143+ [env:extra_check_flags]
144+ platform = ...
145+ board = ...
146+ check_tool = cppcheck, clangtidy
147+ check_skip_packages = yes
You can’t perform that action at this time.
0 commit comments