mirror of
https://github.com/espressif/openthread.git
synced 2026-06-06 05:24:51 +00:00
Abtin Keshavarzian
b5737b4f2b
This commit introduces a new script `update-header-guards.py` which checks for the presence of header guards in `.h` and `.hpp` files and automatically updates them, standardizing the header guard name format across the codebase. The new format for header guards is derived from the full path of the file. For example, `src/core/common/notifier.hpp` will use `OT_CORE_COMMON_NOTIFIER_HPP_`. The guard name includes additional prefixes such as `OT_` or `OPENTHREAD_` to ensure uniqueness. This new naming format handles cases where the same filename may be used in different folders, such as the two `heap.hpp` files located in `src/core/common` and `src/core/utils`. It also ensures that public and platform OpenThread headers under `include/openthread` have uniquely distinct header guard names to avoid conflicts when these headers are included in other projects. The new script helped identify issues with existing header files that lacked header guards (e.g., `posix/system.hpp`) or had improper guards (e.g., `openthread/link_metrics.h`). This commit also introduces a new check script `check-header-guards` to validate that all header guards are correctly formatted. This check is added to the GitHub CI actions to ensure consistency moving forward. All existing header files have been updated (using the new script) to apply the new guard name format.