Skip to content

Commit 461d3db

Browse files
committed
Extend some disclaimers
1 parent 4fae862 commit 461d3db

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

clang/docs/analyzer/user-docs/Options.rst.in

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ also accepted (with equivalent behavior). Analyzer options and checker options
2828
can be freely intermixed here because it's easy to recognize that checker
2929
option names are always prefixed with ``some.groups.NameOfChecker:``.
3030

31+
.. warning::
32+
This is an internal interface, Clang does not intend to preserve backwards
33+
compatibility or announce breaking changes within the flags accepted by
34+
``clang -cc1``. However, ``-analyzer-config`` survived many years without
35+
significant changes and there is no "more official" interface for
36+
configuring the analyzer options.
37+
3138
With the clang driver
3239
---------------------
3340

@@ -61,6 +68,10 @@ note the distinction that the ``clang`` *driver* requires ``--analyze`` (double
6168
dashes) while the ``clang -cc1`` *compiler frontend* requires ``-analyze``
6269
(single dash).
6370

71+
.. note::
72+
The flag ``-Xanalyzer`` is equivalent to ``-Xclang`` in these situations
73+
(but doesn't forward other options of the clang frontend).
74+
6475
With CodeChecker
6576
----------------
6677

@@ -89,9 +100,11 @@ List of analyzer options
89100
========================
90101

91102
.. warning::
92-
These options are primarily intended for development purposes. Changing
93-
their values may drastically alter the behavior of the analyzer, and may
94-
even result in instabilities or crashes!
103+
These options are primarily intended for development purposes and
104+
non-default values are usually unsupported. Changing their values may
105+
drastically alter the behavior of the analyzer, and may even result in
106+
instabilities or crashes! Crash reports are welcome and depending on the
107+
severity they may be fixed.
95108

96109
..
97110
The contents of this section are automatically generated by the script

0 commit comments

Comments
 (0)