FOnline Engine
Current master GitHub
Документация Docs/ru/reference/buildtools/index.md

Сгенерированный справочник CLI BuildTools

Сгенерированный справочник. Не редактируйте эту страницу напрямую. Обновите BuildTools/buildtools.py, затем выполните python BuildTools/docs_cli.py --write.

Индекс справочника Команды Каноническая JSON-модель Контракт генерации

Этот справочник создаётся из того же argparse.ArgumentParser, который использует исполняемая точка входа BuildTools. Поэтому изменение парсера делает устаревшими зафиксированную модель и страницы.

Статус контракта

Поле Значение
Стабильность internal
Начиная с версии Не объявлено
Политика поддержки Версионируемая линия поддержки CLI не объявлена; закрепляйте ревизию движка в автоматизации.
Исходный парсер BuildTools/buildtools.py
Дайджест контракта fe4230108f54098166ceb508251225ab910d03b975cd7bd5267b7c212341d27d

Покрытие

Справочник Записи Назначение
Команды 13 Команды с 25 собственными аргументами.
Глобальные аргументы 0 Аргументы, принимаемые перед командой.

Справка верхнего уровня

usage: buildtools.py [-h] {env,build,validate,setup-mono,format-source,toolset,build-auxiliary,prepare-workspace,repair-checkout-case,package-web-debug,package-android-debug,host-check,prepare-host-workspace} ...

Shared BuildTools helpers

positional arguments:
  {env,build,validate,setup-mono,format-source,toolset,build-auxiliary,prepare-workspace,repair-checkout-case,package-web-debug,package-android-debug,host-check,prepare-host-workspace}
    env                 resolve BuildTools environment
    build               configure and build a target
    validate            configure and validate scenarios
    setup-mono          prepare mono runtime
    format-source       format engine source files
    toolset             build an existing toolset target
    build-auxiliary     build a separately packaged auxiliary tool
    prepare-workspace   prepare shared workspace parts
    repair-checkout-case
                        realign working-tree entry names with the git index
    package-web-debug   package the local web debug client
    package-android-debug
                        package the local android debug client
    host-check          check host prerequisites
    prepare-host-workspace
                        prepare host workspace and prerequisites

options:
  -h, --help            show this help message and exit

Граница

Включено:

  • команды верхнего уровня и аргументы, объявленные функцией create_parser() в BuildTools/buildtools.py
  • значения argparse по умолчанию, варианты, кардинальность, описания, usage и вывод –help

Исключено из этого среза:

  • командные строки вспомогательных скриптов вне BuildTools/buildtools.py
  • объявление package.py и контракты payload
  • семантика validation-целей и внутренние helper-функции Python

Исключённые поверхности остаются деталями реализации, пока для них не будут опубликованы владеющий контракт на основе парсера и политика совместимости.

Введите запрос.