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
33 lines
1.3 KiB
ReStructuredText
33 lines
1.3 KiB
ReStructuredText
.. title:: clang-tidy - readability-avoid-unconditional-preprocessor-if
|
|
|
|
readability-avoid-unconditional-preprocessor-if
|
|
===============================================
|
|
|
|
Finds code blocks that are constantly enabled or disabled in preprocessor
|
|
directives by analyzing ``#if`` conditions, such as ``#if 0`` and ``#if 1``,
|
|
etc.
|
|
|
|
.. code-block:: c++
|
|
|
|
#if 0
|
|
// some disabled code
|
|
#endif
|
|
|
|
#if 1
|
|
// some enabled code that can be disabled manually
|
|
#endif
|
|
|
|
Unconditional preprocessor directives, such as ``#if 0`` for disabled code
|
|
and ``#if 1`` for enabled code, can lead to dead code and always enabled code,
|
|
respectively. Dead code can make understanding the codebase more difficult,
|
|
hinder readability, and may be a sign of unfinished functionality or abandoned
|
|
features. This can cause maintenance issues, confusion for future developers,
|
|
and potential compilation problems.
|
|
|
|
As a solution for both cases, consider using preprocessor macros or defines,
|
|
like ``#ifdef DEBUGGING_ENABLED``, to control code enabling or disabling.
|
|
This approach provides better coordination and flexibility when working with
|
|
different parts of the codebase. Alternatively, you can comment out the entire
|
|
code using ``/* */`` block comments and add a hint, such as ``@todo``,
|
|
to indicate future actions.
|