add_custom_target

Добавить цель без вывода, чтобы она всегда строилась.

add_custom_target(Name [ALL] [command1 [args1...]]
                  [COMMAND command2 [args2...] ...]
                  [DEPENDS depend depend depend ... ]
                  [BYPRODUCTS [files...]]
                  [WORKING_DIRECTORY dir]
                  [COMMENT comment]
                  [VERBATIM] [USES_TERMINAL]
                  [COMMAND_EXPAND_LISTS]
                  [SOURCES src1 [src2...]])

Добавляет цель с заданным именем, которая выполняет заданные команды. Цель не имеет файла вывода и всегда считается устаревшей, даже если команды пытаются создать файл с именем цели. Используйте команду add_custom_command(), чтобы сгенерировать файл с зависимостями. По умолчанию ничего не зависит от пользовательской цели. Используйте команду add_dependencies(), чтобы добавить зависимости к другим целям или из других целей.

Параметры:

ALL

Укажите, что эта цель должна быть добавлена в целевую сборку по умолчанию, чтобы она выполнялась каждый раз (команда не может быть вызвана ALL).

BYPRODUCTS

Укажите файлы, которые, как ожидается, будут созданы командой, но время их модификации может или может не быть обновлено при последующих сборках. Если имя побочного продукта является относительным путем, оно будет интерпретироваться относительно каталога дерева сборки, соответствующего текущему каталогу исходных файлов. Каждый файл побочного продукта будет помечен свойством исходного файла GENERATED автоматически.

Явное указание побочных продуктов поддерживается генератором Ninja для указания ninja инструменту сборки, как нужно пересоздавать побочные продукты, если они отсутствуют. Это также полезно, когда другие правила сборки (например, пользовательские команды) зависят от побочных продуктов. Ninja требует правила сборки для любого сгенерированного файла, от которого зависит другое правило, даже если есть только зависимости по порядку, чтобы гарантировать, что побочные продукты будут доступны до того, как будут построены их зависимости.

Опция BYPRODUCTS игнорируется генераторами, не являющимися Ninja, за исключением маркировки побочных продуктов GENERATED.

COMMAND

Укажите командную строку(и) для выполнения во время сборки. Если указано более одной COMMAND, они будут выполнены в порядке, но не обязательно составлены в состоятельный оболочку или пакетную скрипт. (Для запуска полной скрипта используйте команду configure_file() или команду file(GENERATE) для ее создания, а затем укажите COMMAND для запуска.)

Если COMMAND указывает имя целевого исполняемого файла (созданного командой add_executable()) он будет автоматически заменён местоположением создаваемого во время сборки исполняемого файла. Если задано, свойство целевого исполняемого файла CROSSCOMPILING_EMULATOR также будет добавлено в начало команды, чтобы разрешить запуск исполняемого файла на хосте. Кроме того, будет добавлена зависимость на уровне цели, чтобы целевой исполняемый файл был собран перед этой пользовательской целью.

Аргументы к COMMAND могут использовать generator expressions. Ссылки на имена целей в выражениях генератора подразумевают зависимости на уровне цели.

Команда и аргументы необязательны, и если они не указаны, будет создана пустая цель.

COMMENT

Отобразить данное сообщение перед выполнением команд во время сборки.

DEPENDS

Ссылка на файлы и выходные данные пользовательских команд, созданных с помощью вызовов команды add_custom_command() в одном каталоге (файл CMakeLists.txt). Они будут обновляться при сборке цели.

Используйте команду add_dependencies() для добавления зависимостей от других целей.

COMMAND_EXPAND_LISTS

Списки в аргументах COMMAND будут расширены, включая те, что созданы с помощью generator expressions, что позволит правильно расширять аргументы COMMAND, такие как ${CC} "-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>" foo.cc.

SOURCES

Укажите дополнительные исходные файлы, которые нужно включить в пользовательскую цель. Указанные исходные файлы будут добавлены в файлы проекта IDE для удобства редактирования, даже если у них нет правил сборки.

VERBATIM

Все аргументы к командам будут правильно экранированы для инструмента сборки, чтобы вызываемая команда получала каждый аргумент без изменений. Обратите внимание, что один уровень экранирования всё ещё используется процессором языка CMake перед тем, как add_custom_target даже увидит аргументы. Рекомендуется использовать VERBATIM, так как это обеспечивает правильное поведение. Когда VERBATIM не указано, поведение зависит от платформы, так как нет защиты от платформенно-специфичных специальных символов.

USES_TERMINAL

Команда получит прямой доступ к терминалу, если это возможно. С генератором Ninja это помещает команду в console pool.

WORKING_DIRECTORY

Выполнить команду с заданным текущим каталогом. Если это относительный путь, он будет интерпретирован относительно каталога сборки, соответствующего текущему каталогу исходных файлов.