From 949dcdb3bcc8f3c1084dc933240dbe3546941dad Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 19 May 2023 12:40:36 +1000 Subject: Help: Clarify PRE_BUILD option for add_custom_command() Fixes: #24889 --- Help/command/add_custom_command.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst index 1ccd434..7b3aa1a 100644 --- a/Help/command/add_custom_command.rst +++ b/Help/command/add_custom_command.rst @@ -489,9 +489,12 @@ When the command will happen is determined by which of the following is specified: ``PRE_BUILD`` - On :ref:`Visual Studio Generators`, run before any other rules are - executed within the target. - On other generators, run just before ``PRE_LINK`` commands. + This option has unique behavior for the :ref:`Visual Studio Generators`. + When using one of the Visual Studio generators, the command will run before + any other rules are executed within the target. With all other generators, + this option behaves the same as ``PRE_LINK`` instead. Because of this, + it is recommended to avoid using ``PRE_BUILD`` except when it is known that + a Visual Studio generator is being used. ``PRE_LINK`` Run after sources have been compiled but before linking the binary or running the librarian or archiver tool of a static library. -- cgit v0.12