Skip to content

Commit ed80d0c

Browse files
authored
[NFC][analyzer][docs] Restore/remove orphaned images (#122481)
When commit 61a76f5 converted the static analyzer FAQ from HTML to RST, it accidentally left out three images (`example_*.png`) that were previously present in that document. This commit re-adds those three images to the FAQ (and moves them to the directory for the image assets of the RST documentation). Moreover commit 093aaca _copied_ the file `scan_build_cmd.png` to the RST documentation directory instead of just moving it; so this commit removes its "old" copy which is no longer used (because the old HTML-based documentation file was replaced by a stub that redirects to the RST docs).
1 parent 418f5cd commit ed80d0c

File tree

5 files changed

+6
-0
lines changed

5 files changed

+6
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Custom Assertions
99

1010
Q: How do I tell the analyzer that I do not want the bug being reported here since my custom error handler will safely end the execution before the bug is reached?
1111

12+
.. image:: ../images/example_custom_assert.png
13+
1214
You can tell the analyzer that this path is unreachable by teaching it about your `custom assertion handlers <Annotations.html#custom-assertion-handlers>`__. For example, you can modify the code segment as following:
1315

1416
.. code-block:: c
@@ -25,6 +27,8 @@ Null Pointer Dereference
2527

2628
Q: The analyzer reports a null dereference, but I know that the pointer is never null. How can I tell the analyzer that a pointer can never be null?
2729

30+
.. image:: ../images/example_null_pointer.png
31+
2832
The reason the analyzer often thinks that a pointer can be null is because the preceding code checked compared it against null. If you are absolutely sure that it cannot be null, remove the preceding check and, preferably, add an assertion as well. For example:
2933

3034
.. code-block:: c
@@ -143,6 +147,8 @@ Ensuring Loop Body Execution
143147

144148
Q: The analyzer assumes that a loop body is never entered. How can I tell it that the loop body will be entered at least once?
145149

150+
.. image:: ../images/example_use_assert.png
151+
146152
In cases where you know that a loop will always be entered at least once, you can use assertions to inform the analyzer. For example:
147153

148154
.. code-block:: c
-29 KB
Binary file not shown.

0 commit comments

Comments
 (0)