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

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

Аргументы к WORKING_DIRECTORY могут использовать generator expressions.