derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
38 lines
1.6 KiB
ReStructuredText
38 lines
1.6 KiB
ReStructuredText
==================
|
|
Summary Extraction
|
|
==================
|
|
|
|
.. WARNING:: The framework is rapidly evolving.
|
|
The documentation might be out-of-sync with the implementation.
|
|
The purpose of this documentation is to give context for upcoming reviews.
|
|
|
|
Command-line interface
|
|
**********************
|
|
|
|
Two flags control summary extraction:
|
|
|
|
- ``--ssaf-extract-summaries=<name1>,<name2>,...``: Comma-separated list of summary extractor names to enable.
|
|
- ``--ssaf-tu-summary-file=<path>.<format>``: Output file for the extracted summaries. The file extension selects the serialization format (e.g. ``.json``).
|
|
- ``--ssaf-list-extractors``: List the available summary extractors.
|
|
- ``--ssaf-list-formats``: List the available serialization formats.
|
|
|
|
Example invocation:
|
|
|
|
.. code-block:: bash
|
|
|
|
clang --ssaf-extract-summaries=MyAwesomeAnalysis \
|
|
--ssaf-tu-summary-file=my-tu-summary.json \
|
|
-c input.cpp -o input.o
|
|
|
|
clang --ssaf-list-extractors --ssaf-list-formats
|
|
|
|
Diagnostics
|
|
***********
|
|
|
|
In case the ``--ssaf-*`` flags are used incorrectly, or some extractor fails to implement the desired serialization format
|
|
or just happens to have an error, then the error is forwarded as a ``scalable-static-analysis-framework`` error.
|
|
These errors can be downgraded into warnings using ``-Wno-error=scalable-static-analysis-framework``.
|
|
These errors can be completely suppressed using ``-Wno-scalable-static-analysis-framework``.
|
|
|
|
See the `diagnostic flags <https://clang.llvm.org/docs/DiagnosticsReference.html#wscalable-static-analysis-framework>`_ for the full list of diagnostics controlled by ``-Wscalable-static-analysis-framework``.
|