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]
                  [JOB_SERVER_AWARE <bool>]
                  [VERBATIM] [USES_TERMINAL]
                  [COMMAND_EXPAND_LISTS]
                  [SOURCES src1 [src2...]])

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

Параметры:

ALL

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

BYPRODUCTS

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

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

См. политику CMP0058 для мотивации этой функции.

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

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

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

Изменено в версии 3.28: В пользовательских целях, использующих Наборы файлов, побочные продукты теперь считаются приватными, если они не перечислены в не-приватном наборе файлов. См. политику CMP0154.

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

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

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

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 во время сборки.

JOB_SERVER_AWARE

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

Указывает, что команда учитывает сервер задач GNU Make.

Для генераторов Unix Makefiles, MSYS Makefiles и MinGW Makefiles это добавит префикс + к строке рецепта. Обратитесь к документации GNU Make для получения дополнительной информации.

Этот параметр будет проигнорирован другими генераторами.

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 Многоконфигурационный

См. также

• add_custom_command()