cmake: Treat pristine build warnings as errors #77843
Conversation
A pristine build is needed when snippets are changed. Currently this only triggers a warning which can easily be missed. Signed-off-by: Andriy Gelman <[email protected]>
zephyrbot
added
area: Build System
size: XS
zephyrbot
requested review from
57300,
jeremybettis,
nashif,
nordicjm and
tejlmand
| @@ -3328,7 +3328,7 @@ function(zephyr_check_cache variable) | |||
| # without cleaning first | |||
| if(cli_argument) | |||
| if(NOT ((CACHED_${variable} STREQUAL cli_argument) OR (${variable}_DEPRECATED STREQUAL cli_argument))) | |||
| message(WARNING "The build directory must be cleaned pristinely when " | |||
| message(FATAL_ERROR "The build directory must be cleaned pristinely when " | |||
There was a problem hiding this comment.
this is not only impacting snippets but is impacting every setting which are not allowed to be changed, including BOARD and SHIELD.
Thus I believe a broader audience should be included if we're to change the build system behavior.
Also. if this is changed to an error, then the following code, which becomes dead code with the proposed change, should be cleaned up in addition.
There was a problem hiding this comment.
I'll have a look at cleaning up the following code. Also changed the title to take into account your feedback.
There was a problem hiding this comment.
another, and perhaps better alternative, is to change from WARNING to AUTHOR_WARNING.
That will allow developers to error on warnings by calling cmake with: -Werror=dev, while still keeping it a warning for others.
There was a problem hiding this comment.
By the way, an error is already thrown by West when compiling for a different target board without a pristine build:
But it will create a warning when run with cmake directly. Shouldn't we be consistent between cmake and west?
There was a problem hiding this comment.
not sure why west build decided to error out early on board, but zephyr_check_cache is a common available Zephyr CMake extension function which can used elsewhere, even by downstream projects / modules.
glenn-andrews
dismissed
their stale review
Didn't think through the implications properly.
talih0
changed the title
A pristine build is needed when snippets are changed. Currently, this only triggers a warning which can easily be missed and the new target snippets won't be applied.Make the warning an error.
A pristine build is needed when snippets/boards/shields are changed. Currently, this is treated as a warning which can be easily missed and the new settings won't be applied. Treat the warning as an error.