pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update warning on undefined variables in api-guides/build-system

Browse Source
This commit is contained in:
Linda
2022-10-12 14:39:53 +08:00
parent 1bbd524a7c
commit 0a8a67ecd0
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-guides/build-system.rst
+2 -2
View File
@@ -696,9 +696,9 @@ It also defines an overridden custom version of the built-in CMake_ ``project``
Warning On Undefined Variables
------------------------------
By default, ``idf.py`` passes the ``--warn-uninitialized`` flag to CMake_ so it will print a warning if an undefined variable is referenced in the build. This can be very useful to find buggy CMake files.
By default, the function of warnings on undefined variables is disabled.
If you don't want this behaviour, it can be disabled by passing ``--no-warnings`` to ``idf.py``.
To enable this function, we can pass the ``--warn-uninitialized`` flag to CMake_ or pass the ``--cmake-warn-uninitialized`` flag to ``idf.py`` so it will print a warning if an undefined variable is referenced in the build. This can be very useful to find buggy CMake files.
Browse the :idf_file:`/tools/cmake/project.cmake` file and supporting functions in :idf:`/tools/cmake/` for more details.