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
52 lines
1.8 KiB
ReStructuredText
52 lines
1.8 KiB
ReStructuredText
.. title:: clang-tidy - portability-restrict-system-includes
|
|
|
|
portability-restrict-system-includes
|
|
====================================
|
|
|
|
Checks to selectively allow or disallow a configurable list of system headers.
|
|
|
|
For example:
|
|
|
|
In order to **only** allow `zlib.h` from the system you would set the options
|
|
to `-*,zlib.h`.
|
|
|
|
.. code-block:: c++
|
|
|
|
#include <curses.h> // Bad: disallowed system header.
|
|
#include <openssl/ssl.h> // Bad: disallowed system header.
|
|
#include <zlib.h> // Good: allowed system header.
|
|
#include "src/myfile.h" // Good: non-system header always allowed.
|
|
|
|
In order to allow everything **except** `zlib.h` from the system you would set
|
|
the options to `*,-zlib.h`.
|
|
|
|
.. code-block:: c++
|
|
|
|
#include <curses.h> // Good: allowed system header.
|
|
#include <openssl/ssl.h> // Good: allowed system header.
|
|
#include <zlib.h> // Bad: disallowed system header.
|
|
#include "src/myfile.h" // Good: non-system header always allowed.
|
|
|
|
Since the options support globbing you can use wildcarding to allow groups of
|
|
headers.
|
|
|
|
`-*,openssl/*.h` will allow all openssl headers but disallow any others.
|
|
|
|
.. code-block:: c++
|
|
|
|
#include <curses.h> // Bad: disallowed system header.
|
|
#include <openssl/ssl.h> // Good: allowed system header.
|
|
#include <openssl/rsa.h> // Good: allowed system header.
|
|
#include <zlib.h> // Bad: disallowed system header.
|
|
#include "src/myfile.h" // Good: non-system header always allowed.
|
|
|
|
Options
|
|
-------
|
|
|
|
.. option:: Includes
|
|
|
|
A string containing a comma separated glob list of allowed include
|
|
filenames. Similar to the -checks glob list for running clang-tidy itself,
|
|
the two wildcard characters are `*` and `-`, to include and exclude globs,
|
|
respectively. The default is `*`, which allows all includes.
|