https://github.com/smrtos/ZephyrIncludeMap
Header include map generator for Zephyr RTOS
https://github.com/smrtos/ZephyrIncludeMap
Last synced: about 1 month ago
JSON representation
Header include map generator for Zephyr RTOS
- Host: GitHub
- URL: https://github.com/smrtos/ZephyrIncludeMap
- Owner: smrtos
- Created: 2021-09-14T09:38:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-25T09:14:00.000Z (over 2 years ago)
- Last Synced: 2024-10-29T02:31:37.087Z (6 months ago)
- Language: Python
- Size: 1.35 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-zephyr-rtos - Header include map generator for Zephyr RTOS
README
# ZephyrIncludeMap
Header include map generator for Zephyr RTOS
This tool generates include map for a Zephyr C source file.
The generation is based on C preprocessor result.
So it is NOT necessarily exactly the same as what you see in C source file.
For example, A xxx.h file with include guard will not be included at a certain position
of yyy.c if a previous zzz.h in yyy.c has included xxx.h already.
The include map will only show the xxx.h file under zzz.h rather than under yyy.c.
In short, it reflects the final effecive result of the include hierarchy.
But it is good enough, isn't it?
```
IncludeMap ver 0.1
By Shao, Ming ([email protected])
[Description]:
This tool generates a map of included headers for a Zephyr .c file in the context of a Zephyr build.
[Pre-condition]:
A Zephyr build must be made before using this tool because some build-generated files are needed.
[Usage]:
GenIncludeMap
: the Zephyr folder path.
: the Zephyr build folder where build.ninja file is located.
: the full path of the GCC used to build Zephyr.
: the full path of the include directory that comes with your GCC bundle.
: the full path of the Zephyr source file to generate include map for.
```
A sample command:
> python3 GenIncludeMap2.py ~/sources/zephyrproject/zephyr/ ~/sources/zephyrproject/zephyr/build ~/dev/toolchain/arm32-none-eabi/bin/arm-none-eabi-gcc ~/dev/toolchain/arm32-none-eabi/lib/gcc/arm-none-eabi/13.3.1/include ~/sources/zephyrproject/zephyr/samples/drivers/uart/echo_bot/src/main.c