[PATCH] D64801: [analyzer] Add CTU user docs

Daniel Krupp via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Wed Jul 17 02:54:15 PDT 2019

dkrupp requested changes to this revision.
dkrupp added a comment.
This revision now requires changes to proceed.

Thanks Gabor for writing this. 
I suggested some minor changes to the txt. Otherwise LGTM.

Comment at: clang/docs/analyzer/user-docs/CrossTranslationUnit.rst:98
+This manual procedure is boring and error-prone, so sooner or later we'd like to have a script which automates this for us.
since CodeChecker automation is already available I suggest rephrasing.

This manual procedure is error-prone and not scalable, so for analyzing real projects it is recommended to use the built-in support of  CodeChecker or scan-build-py.

Comment at: clang/docs/analyzer/user-docs/CrossTranslationUnit.rst:142
+The `plist` files contain the results of the analysis, which may be viewed with the regular analysis tools.
+E.g. one may use `CodeChecker server` and `CodeChecker store` to store and view the results in a web browser.
I suggest to replace this line with the following:
E.g. one may use CodeChecker parse to view the results in command line or CodeChecker parse -e html to export them into HTML format.

pure command line usage without worrying about the server setup better fits this command line use-case.

Comment at: clang/docs/analyzer/user-docs/CrossTranslationUnit.rst:147
+We actively develop CTU with CodeChecker as a "runner" script, `scan-build` is not actively developed for CTU.
+`scan-build` has different errors and issues, expect it to work with the very basic projects only.
Some basic usage description could be added still...

  rG LLVM Github Monorepo



More information about the cfe-commits mailing list