899f26315c
This commit documents the process of specifying values for the analyzer options and checker options implemented in the static analyzer, and adds a script which includes the documentation of the analyzer options (which was previously only available through a command-line flag) in the RST-based web documentation.
15 lines
652 B
Plaintext
15 lines
652 B
Plaintext
The documentation of analyzer options is generated by a script that parses
|
|
AnalyzerOptions.def. The following line validates that this script
|
|
"understands" everything in its input files:
|
|
|
|
RUN: %python %src_dir/docs/tools/generate_analyzer_options_docs.py \
|
|
RUN: --options-def %src_include_dir/clang/StaticAnalyzer/Core/AnalyzerOptions.def \
|
|
RUN: --template %src_dir/docs/analyzer/user-docs/Options.rst.in \
|
|
RUN: --out %t.rst
|
|
|
|
Moreover, verify that the documentation (e.g. this fragment of the
|
|
documentation of the "mode" option) can be found in the output file:
|
|
|
|
RUN: FileCheck --input-file=%t.rst %s
|
|
CHECK: Controls the high-level analyzer mode
|