add_custom_target

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

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

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

Параметры:

ALL

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

BYPRODUCTS

Новая в версии 3.2.

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

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

Генераторы Makefile Generators удалят BYPRODUCTS и другие файлы GENERATED во время make clean.

Новая в версии 3.20: Аргументы к BYPRODUCTS могут использовать ограниченный набор generator expressions. Зависимые от целевых выражения не допускаются.

COMMAND

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

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

• Цель не компилируется для другой платформы (т.е. переменная CMAKE_CROSSCOMPILING не установлена в значение true).

• Новая в версии 3.6: Цель компилируется для другой платформы и предоставляется эмулятор (т.е. её свойство цели CROSSCOMPILING_EMULATOR установлено). В этом случае содержимое CROSSCOMPILING_EMULATOR будет добавлено в начало команды перед местоположением исполняемого файла цели.

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

Аргументы к COMMAND могут использовать generator expressions. Используйте выражение генератора TARGET_FILE, чтобы сослаться на расположение цели позже в командной строке (т.е. в качестве аргумента команды, а не как команды для выполнения).

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

• TARGET_FILE
• TARGET_LINKER_FILE
• TARGET_SONAME_FILE
• TARGET_PDB_FILE

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

COMMENT

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

DEPENDS

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

Изменено в версии 3.16: Добавляется зависимость уровня цели, если какая-либо зависимость является побочным продуктом цели или любого из её событий построения в том же каталоге, чтобы гарантировать, что побочные продукты будут доступны перед построением этой цели.

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

COMMAND_EXPAND_LISTS

Новая в версии 3.8.

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

JOB_POOL

Новая в версии 3.15.

Укажите pool для генератора Ninja. Несовместимо с USES_TERMINAL, что подразумевает пул console . Использование пула, не определённого в JOB_POOLS, вызывает ошибку ninja во время построения.

SOURCES

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

VERBATIM

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

USES_TERMINAL

Новая в версии 3.2.

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

WORKING_DIRECTORY

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

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

Ninja Multi-Config