Help: Clarify PRE_BUILD option for add_custom_command()

Fixes: #24889
This commit is contained in:
Craig Scott
2023-05-19 12:40:36 +10:00
parent 5056a224dc
commit 949dcdb3bc

View File

@@ -489,9 +489,12 @@ When the command will happen is determined by which
of the following is specified: of the following is specified:
``PRE_BUILD`` ``PRE_BUILD``
On :ref:`Visual Studio Generators`, run before any other rules are This option has unique behavior for the :ref:`Visual Studio Generators`.
executed within the target. When using one of the Visual Studio generators, the command will run before
On other generators, run just before ``PRE_LINK`` commands. 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`` ``PRE_LINK``
Run after sources have been compiled but before linking the binary Run after sources have been compiled but before linking the binary
or running the librarian or archiver tool of a static library. or running the librarian or archiver tool of a static library.