[PATCH] D58065: [analyzer] Document the frontend library

Whisperity via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Tue Mar 12 03:25:19 PDT 2019


whisperity added inline comments.


================
Comment at: docs/analyzer/developer-docs/FrontendLibrary.rst:85
+    -fuse-ld=lld \
+    ../llvm
+
----------------
george.karpenkov wrote:
> Information on compiling LLVM IMO should not be here.
> Also, why Sphinx? Why X86? Why LLD and not gold?
> Information on compiling LLVM IMO should not be here.
> Also, why Sphinx? Why X86? Why LLD and not gold?

Analyser for development -- however, you build `release` instead of (at least) `RelWithDebInfo`.

`EXPORT_COMPILE_COMMANDS` is also totally unnecessary for an "analyser for development".

Perhaps individual recommended settings could be linked back to the configuration guide's sections? (Unfortunately that guide can't link to individual //options// sadly.)


================
Comment at: docs/analyzer/developer-docs/FrontendLibrary.rst:94
+Other documents detail the difference between the *driver* and the *frontend*
+of clang far more precisely, but we'll touch on this briefly: When you input
+``clang`` into the command line, you invoke the driver. This compiler driver
----------------
When we talk about the project, use **C**lang. When talking about the binary, `clang` in monospace is good style.


================
Comment at: docs/analyzer/developer-docs/FrontendLibrary.rst:140
+
+Although we don't support running the analyzer without enabling the entire core
+package, it is possible, but might lead to crashes and incorrect reports.
----------------
`core` for emphasis.


Repository:
  rC Clang

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

https://reviews.llvm.org/D58065





More information about the cfe-commits mailing list