Skip to content

Commit ba7c401

Browse files
NagyDonatkrishna2803
authored andcommitted
[NFC][analyzer] Update docs of CodeChecker --ctu-ast-mode (llvm#144901)
The documentation of the cross translation unit analysis mentioned a certain flag of `CodeChecker` (an external open source tool that can be used to drive the static analysis), but the information about it was obsolete: apparently the name of the flag, the names of the possible values, and the default value were all changed. Currently `CodeChecker analyze --help` displays this flag as ``` --ctu-ast-mode {load-from-pch,parse-on-demand} Choose the way ASTs are loaded during CTU analysis. Only available if CTU mode is enabled. Mode 'load-from-pch' generates PCH format serialized ASTs during the 'collect' phase. Mode 'parse-on-demand' only generates the invocations needed to parse the ASTs. Mode 'load- from-pch' can use significant disk-space for the serialized ASTs, while mode 'parse-on-demand' can incur some runtime CPU overhead in the second phase of the analysis. (default: parse-on-demand) ``` and I tried to follow this in the commands that I adjusted. Note that this documentation file probably contains other obsolete details as well, but I didn't try to find or fix them.
1 parent f7d914f commit ba7c401

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

clang/docs/analyzer/user-docs/CrossTranslationUnit.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Once we have set up the `PATH` environment variable and we activated the python
132132

133133
.. code-block:: bash
134134
135-
$ CodeChecker analyze --ctu compile_commands.json -o reports
135+
$ CodeChecker analyze --ctu --ctu-ast-mode load-from-pch compile_commands.json -o reports
136136
$ ls -F
137137
compile_commands.json foo.cpp foo.cpp.ast main.cpp reports/
138138
$ tree reports
@@ -318,7 +318,7 @@ Once we have set up the `PATH` environment variable and we activated the python
318318

319319
.. code-block:: bash
320320
321-
$ CodeChecker analyze --ctu --ctu-ast-loading-mode on-demand compile_commands.json -o reports
321+
$ CodeChecker analyze --ctu compile_commands.json -o reports
322322
$ ls -F
323323
compile_commands.json foo.cpp main.cpp reports/
324324
$ tree reports

0 commit comments

Comments
 (0)