diff options
| author | Craig Scott <craig.scott@crascit.com> | 2022-06-04 08:30:17 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2022-06-04 08:35:37 (GMT) |
| commit | 8cf8f4d13b18ad28cc33dbc765a095dcf679391b (patch) | |
| tree | 0e64a06849b5ed50b6285b3e8109947980c650df | |
| parent | cc2c5d4eb536b220421835ed2eb40729337fd53a (diff) | |
| download | CMake-8cf8f4d13b18ad28cc33dbc765a095dcf679391b.zip CMake-8cf8f4d13b18ad28cc33dbc765a095dcf679391b.tar.gz CMake-8cf8f4d13b18ad28cc33dbc765a095dcf679391b.tar.bz2 | |
Help: State behavior for add_custom_command(TARGET) without event type
Projects should always have specified one of PRE_BUILD, PRE_LINK or
POST_BUILD, and the documentation has always shown that one must
be given. But the argument parsing logic was such that if none was given,
POST_BUILD would be used and no error or warning would be raised.
Projects may be relying on this behavior, so document it as formally
supported, but not recommended.
Fixes: #23488
| -rw-r--r-- | Help/command/add_custom_command.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst index 4fe9326..9e60d2d 100644 --- a/Help/command/add_custom_command.rst +++ b/Help/command/add_custom_command.rst @@ -425,6 +425,11 @@ of the following is specified: ``POST_BUILD`` Run after all other rules within the target have been executed. +Projects should always specify one of the above three keywords when using +the ``TARGET`` form. For backward compatibility reasons, ``POST_BUILD`` is +assumed if no such keyword is given, but projects should explicitly provide +one of the keywords to make clear the behavior they expect. + .. note:: Because generator expressions can be used in custom commands, it is possible to define ``COMMAND`` lines or whole custom commands |