keremet/mkimage-profiles
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

features: hopefully better README

Browse Source 
Thanks both drool@ for his mild frustration with the current
documentation as well as Greg Kroah-Hartman, Heikki Orsila
and Neil Brown for http://lwn.net/Articles/504814/ -- the docs
should really emphasize *why* something is done, not *how*,
as the "how" part is better documented with the code itself
(that doesn't mean that "the big picture" isn't needed).
This commit is contained in:
Michael Shigorin 2012-08-11 21:45:26 +03:00
parent b21353a00c
commit c08e86afc5
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
features.in/README
View File

@ -1,28 +1,28 @@
Этот каталог содержит т.н. фичи (features, особенности) -- Этот каталог содержит т.н. фичи (features, особенности).
каталоги, содержимое каждого из которых реализует одну из
подключаемых автономных возможностей образа.
Каждая фича должна содержать задействуемый при построении Фича -- отдельно подключаемая сущность, которая содержит
конфигурации будущего образа файл config.mk, включаемый повторно используемые конфигурацию/код и определяет одну
в ../main.mk; он может описывать одну или более целей из особенностей создаваемого образа. Может зависеть от
вида use/*, дополняющих конфигурацию, и при наличии других фич либо субпрофилей.
дополнительных хуков для копирования или generate.*
обязан добавить имя фичи в $(FEATURES), для чего Каждая фича должна содержать файл config.mk, включаемый
создана функция add_feature без аргументов. в ../main.mk при построении конфигурации будущего профиля;
он может описывать одну или более целей вида use/*,
дополняющих конфигурацию, и обязан добавить имя фичи
в $(FEATURES), для чего создана функция add_feature.
На этапе генерации сборочного профиля фичи рассматриваются На этапе генерации сборочного профиля фичи рассматриваются
после инициализации профиля (см. ../image.in/) и копирования после инициализации профиля (см. ../image.in/) и копирования
субпрофилей (см. ../sub.in/). Для каждой фичи, указанной субпрофилей (см. ../sub.in/). Для каждой фичи, указанной
в $(FEATURES), копируются подкаталоги сообразно субпрофилям, в $(FEATURES), копируются подкаталоги сообразно включенным
а также производится обработка {image-,}scripts.d/; затем субпрофилям, а также lib/ и {image-,}scripts.d/; затем
выполняется скрипт generate.sh и задействуется generate.mk выполняются generate.sh и generate.mk при их наличии.
(при их наличии).
Если фича дополняет хуками семейство целевых субпрофилей, Если фича дополняет хуками семейство целевых субпрофилей,
построенных на одном базовом, можно воспользоваться подкаталогом построенных на одном базовом, можно воспользоваться подкаталогом
с именем исходного базового субпрофиля (см. $src, $dst в Makefile). с именем исходного базового субпрофиля (см. $src, $dst в Makefile).
Наиболее употребительные цели можно снабжать "ярлычками" вроде Наиболее востребованные цели можно снабжать "ярлычками" вроде
"+icewm" с тем, чтобы сделать более краткими и выразительными "+icewm" с тем, чтобы сделать более краткими и выразительными
использующие их правила. Просьба не злоупотреблять количеством. использующие их правила. Просьба не злоупотреблять количеством.