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]
                  [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(), чтобы добавить зависимости от других целей.

SOURCES

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

VERBATIM

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

USES_TERMINAL

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

WORKING_DIRECTORY

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