ты технический писатель. Ты знаешь, что " 1. Адаптеры для инструментов и сборочные…
- User
ты технический писатель. Ты знаешь, что "
- Адаптеры для инструментов и сборочные скрипты располагаются в директории build/scripts.
- Скрипты, реализуют логику сборочных команд в случаях, когда сборочный инструмент нельзя вызвать напрямую.
- Скрипты пишут на C++ и Python
- Скрипты используются макросами, описывающие команды Такие макросы описывают команды, которые должны быть исполнены в процессе сборки. Макрос формирует команду, которая встраивается в сборочный граф своего модуля за счёт связывания своих результатов с входами других команд (потребителей) и, возможно, своих входов с результатами других команд (источников). Вот пример из конфигурационного файла сборки "# tag:internal
@usage: CHECK_CONFIG_H(<conf_header>) # internal
This internal macro adds checking code for configuration header in external (contrib) library.
The check is needed to avoid conflicts on certain types and functions available in arcadia.
macro CHECK_CONFIG_H(Conf) { .CMD={input:"build/scripts/check_config_h.py"} {output;nopath;noext:Conf.config.cpp} {hide;kv:"pc yellow"} OUTPUT_INCLUDES=$Conf }" 5. В скрипты можно передавать параметры. " Напиши раздел документации о скриптах системя сборки.
- Assistant
Раздел документации: Скрипты в системе сборки
Введение
В системе сборки используются специальные скрипты, которые располагаются в директории
build/scripts. Эти скрипты призваны обеспечить выполнение сборочных команд в тех случаях, когда сборочный инструмент нельзя вызвать напрямую. Основные сценарии их использования включают адаптацию сборочных инструментов и реализацию кастомной логики сборки.Поддерживаемые языки
Скрипты пишутся на следующих языках программирования:
- C++
- Python
Выбор языка зависит от требуемой функциональности и особенностей конкретной задачи в процессе сборки.
Логика работы
Скрипты используются при помощи макросов, которые описывают команды, необходимые для процесса сборки. Такие макросы создают команды, которые затем встраиваются в сборочный граф конкретного модуля. Эти команды взаимодействуют друг с другом через связывание входов и выходов различных команд.
Пример макроса
Рассмотрим пример макроса из конфигурационного файла сборки:
# tag:internal ### @usage: CHECK_CONFIG_H(<conf_header>) # internal ### ### This internal macro adds checking code for configuration header in external (contrib) library. ### The check is needed to avoid conflicts on certain types and functions available in arcadia. ### macro CHECK_CONFIG_H(Conf) { .CMD=$YMAKE_PYTHON ${input:"build/scripts/check_config_h.py"} ${input;rootrel:Conf} ${output;nopath;noext:Conf.config.cpp} ${hide;kv:"p CH"} ${hide;kv:"pc yellow"} OUTPUT_INCLUDES=$Conf }- Тег типа макроса:
# tag:internal - Описание использования:
### @usage: CHECK_CONFIG_H(<conf_header>) # internal
Описание макроса
CHECK_CONFIG_HМакрос
CHECK_CONFIG_Hдобавляет проверки в конфигурационный заголовочный файл (<conf_header>) в сторонней библиотеке. Это необходимо для избегания конфликтов в определённой библиотеке на типы и функции, доступные вarcadia.Параметры макроса
Параметры макроса задаются в следующем формате:
${input:"build/scripts/check_config_h.py"}- указывает на входной скриптcheck_config_h.py, который необходимо запустить.${input;rootrel:Conf}– параметрConfуказывает на конфигурационный заголовочный файл.${output;nopath;noext:Conf.config.cpp}– выходной файл, который будет создан на основеConfи не будет включать путь и расширение.${hide;kv:"p CH"}и${hide;kv:"pc yellow"}– скрытые параметры, задающие дополнительные настройки команд.
Связывание команд
Каждый макрос формирует команду, которая затем встраивается в сборочный граф своего модуля. Связывание результатов одной команды с входами других команд (потребителей) и, возможно, своих входов с результатами других команд (источников) обеспечивает согласованную и последовательную сборку проекта.
Передача параметров в скрипты
В скрипты можно передавать параметры, что обеспечивает гибкость и настраиваемость процесса сборки. Параметры могут быть различного типа и указываются внутри макросов. Передача параметров позволяет адаптировать выполнение скриптов под конкретные необходимости и особенности сборки.
Таким образом, скрипты в системе сборки являются важным инструментом для реализации различных задач, значительно расширяя возможности стандартных сборочных инструментов и обеспечивая более гибкий и мощный процесс сборки.