Help: Clarify add_custom_command COMMENT display timing

The "before the commands are executed" wording predated the Ninja
generator; the native build tool controls when and how it is shown.

Fixes: #27991
This commit is contained in:
Daksh Mamodiya
2026-07-27 17:42:22 +02:00
parent 41b071e482
commit 9d9733a7f5
+4 -2
View File
@@ -167,8 +167,10 @@ Generating Files
dependencies.
``COMMENT``
Display the given message before the commands are executed at
build time. This will be ignored if ``APPEND`` is given, although a future
Display the given message associated with running the commands at build
time. The message is passed to the native build tool, which controls when
and how it is shown, so its exact timing relative to the commands is not
guaranteed. This will be ignored if ``APPEND`` is given, although a future
version may use it.
.. versionadded:: 3.26