FreeSource : AltLinux/Sisyphus/Alterator/sdk

TODO

• переложить в /usr/share/alterator/sdk, /etc/alterator/sdk
• LABEL == DESCRIPTION
• добавить help

Alterator-sdk

alterator-sdk — программа для для изготовления шаблонов модулей alterator. Программа последовательно запускает указанные скрипты-"генераторы", каждый из которых создает определенную часть модуля в соответствии с параметрами настройки.

параметры командной строки

alterator-sdk [параметры] <генератор1> ... <генераторN>

параметры:

-h --help — вывести помощь по параметрам командной строки и выйти

-d --defaults — вывести значения по умолчанию для всех параметров настройки и выйти

-g --generators — вывести список всех генераторов и выйти

-p --profiles — вывести список всех профилей и выйти

-r --root <dir> — использовать директорию dir в качестве корневой директории проекта. Значение по умолчанию: "."

-s --set <name>=<value> — установить значение параметра конфигурации

генераторы и конфигурация

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

• глобальный файл конфигурации /etc/alterator-sdk
• локальный файл конфигурации .alterator-sdk в корневой директории проекта
• параметры командной строки -s

Для создания файла локальных настроек полезно использовать генератор init. Он создает в корневой директории проекта файл .alterator-sdk, в который записывает параметры конфигурации (глобальные, перекрытые локальными если они есть, перекрытые параметрами из командной строки).

alterator-sdk -s NAME=mymodule init

Список всех параметров настройки и их значения по умолчанию выводятся командой alterator-sdk --defaults

Список всех генераторов выводится командой alterator-sdk --generators

профили модулей

Предполагается, что с помощью alterator-sdk можно создавать модули в соответствии с несколькими стандартными профилями. Выбор профиля управляется параметром настройки PROFILE.

Список профилей можно выводится командой alterator-sdk --profiles

Простое использование

• mkdir mymodule; cd mymodule
• alterator-sdk init
• vi .alterator-sdk
• alterator-sdk all

внутренности

Скрипты-генераторы лежат в /usr/share/altertor-sdk/generators/. Каждый скрипт может быть запущен с параметром -h — в этом случае он выведет строчку со своим кратким описанием, или без параметров — в этом случае он будет вполнять необходимые действия. Все действия выполняются в текущей директории, все настройки передаются через переменные окружения ALTERATOR_SDK_<name>.

Кроме настроек из /etc/alterator-sdk в генераторы передаются следующие параметры

• ALTERATOR_SDK_GENSPATH — директория с генераторами (/usr/share/altertor-sdk/generators)
• ALTERATOR_SDK_PROFPATH — директория с профилями (/usr/share/altertor-sdk/profiles)

В директории /usr/share/altertor-sdk/profiles/ лежат данные, разложенные по поддиректориям с названиями профилей. В каждой директории должен лежать файл descr с описанием профиля.

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