Многие приложения могут быть построены в различных конфигурациях и с дополнительной функциональностью. Например, выбор естественного (человеческого) языка, GUI против командной строки или типа используемой базы данных. Пользователи могут нуждаться в различных конфигурациях, отличных от используемой по умолчанию, поэтому в системе портов предусмотрен механизм, позволяющий автору порта управлять сборкой того или иного варианта конфигурации. Правильная поддержка этих необязательных параметров облегчает пользователям жизнь и даёт два или более порта по цене одного.
Эти переменные предназначены для установки системным
администратором. Многие из них стандартизованы в файле
ports/KNOBS
.
При создании порта не давайте имя для knob, специфичное
для данного приложения. На примере порта Avahi, используйте
WITHOUT_MDNS
вместо
WITHOUT_AVAHI_MDNS
.
Не стоит рассчитывать, что
WITH_
обязательно имеет соответствующую переменную
*
WITHOUT_
,
и наоборот. В общем случае, предполагается значение по
умолчанию.*
Если обратное не указано, то проверяется только факт
установки самих переменных, но не их конкретное значение типа
YES
или NO
.
WITH_*
и WITHOUT_*
Портеры должны использовать так называемые
knobs для помощи конечным пользователям и для поддержания
количества наименований knobs в небольшом количестве.
Список популярных названий knobs можно найти в файле KNOBS
Названия knobs должны отражать, что это такое и что
выполняет. Если у порта имеется библиотечный префикс в
PORTNAME
, то он должен присутствовать в
названии knobs.
При установке порта переменные OPTIONS_*
предоставляют пользователю окно диалога с отображением
доступных параметров, с записью выбранных параметров в файл
/var/db/ports/
.
Эти опции повторно используются при следующем построении
порта.${UNIQUENAME}
/options
Когда пользователь запускает make config
(или запускает впервые make build
),
инфраструктура выполняет проверку существования файла
/var/db/ports/
.
Если этот файл не существует, то используются значения
${UNIQUENAME}
/optionsOPTIONS_*
и отображается диалоговое окно,
в котором эти параметры можно включить или выключить.
Затем сохраняется файл опций options
,
и выбранные переменные используются при построении порта.
Если новая версия порта добавляет новые значения
OPTIONS
, то пользователю будет представлено
окно диалога с сохраненными заполненными значениями старых
OPTIONS.
make showconfig
отображает
сохраненную конфигурацию. Для удаления
сохраненной конфигурации используйте
make rmconfig
.
OPTIONS_DEFINE
содержит список
используемых OPTIONS
. Они независимы
друг от друга и не сгруппированы:
Далее после определения следует описание
OPTIONS
(не является обязательным,
но настоятельно рекомендуется):
ports/Mk/bsd.options.desc.mk
содержит описание множества наиболее используемых
OPTIONS
; переопределять их, как
правило, не нужно.
При описании параметров старайтесь представить себя
на месте пользователя: «Что это делает?»
и «Для чего бы я захотел включить это?»
Не делайте простое повторение названия. Например,
описание параметра NLS
как
«include NLS support» («включить
поддержку NLS») не поможет пользователю, который
уже видит название параметра, но может не знать, что
это означает. Описав его как «Native Language
Support via gettext utilities» («Поддержка
национального языка через утилиты gettext»),
вы поможете пользователю гораздо больше.
OPTIONS
можно группировать в виде
переключателей, для которых разрешен выбор единственного
варианта в каждой группе:
OPTIONS
также можно группировать
в виде списков со множественным выбором, для которых
обязан быть включен по крайней мере
один из параметров:
OPTIONS_MULTI
и
OPTIONS_SINGLE
также допускают
отсутствие выбора путём включения группы в
OPTIONS_DEFINE
:
После этого группа требует по крайней мере один
OPTION
из MG1
,
только если выбран новый MG1
OPTION
. Рекомендуется
поэкспериментировать, чтобы улучшить понимание.
По умолчанию OPTIONS
находится в
выключенном положении, если при этом оно также отсутствует
в списке OPTIONS_DEFAULT
:
Определения OPTIONS
обязаны появиться
до подключения bsd.port.options.mk
.
Переменные PORT_OPTIONS
могут быть проверены только после
подключения bsd.port.options.mk
.
Вместо этого также можно использовать подключение
bsd.port.pre.mk
, что все еще широко
используется в портах, написанных до появления
bsd.port.options.mk
. Но имейте в виду,
что некоторые переменные, обычно, это некоторые флаги
USE_*
,
после подключения bsd.port.pre.mk
будут
работать не так, как этого от них ожидают.
OPTIONS
OPTIONS
OPTIONS
в старом стилеТакой способ использования OPTIONS
является устаревшим, и в будущем его поддержка будет
удалёна. Не используйте этот способ для новых портов.
При использовании сценария GNU configure, следите за тем,
какие необязательные функции задействуются посредством
автоматической активации. Отключайте явным образом те
необязательные функции, которые вы не хотели бы использовать,
через передачу соответствующих --without-xxx
или --disable-xxx
в переменной
CONFIGURE_ARGS
.
В приведенном выше примере представьте себе библиотеку libfoo,
установленную в системе. Пользователь не желает, чтобы приложение
использовало libfoo, и поэтому он выключает соответствующую опцию
в диалоге make config
. Но сценарий configure
приложения определяет наличие библиотеки в системе и включает ее
поддержку в итоговый исполняемый файл. Теперь, когда пользователь
решит удалить libfoo из системы, система портов позволит это
сделать (т.к. зависимость от libfoo не была записана), но
приложение перестанет работать.
Во втором примере библиотека libfoo отключена явным образом. Сценарий configure не включает соответствующие функции в приложении, несмотря на присутствие библиотеки в системе.
Этот, и другие документы, могут быть скачаны с http://ftp.FreeBSD.org/pub/FreeBSD/doc/.
По вопросам, связанным с FreeBSD, прочитайте
документацию прежде чем писать в
<questions@FreeBSD.org>.
По вопросам, связанным с этой документацией, пишите в рассылку
<doc@FreeBSD.org>.