keremet/mkimage-profiles
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
24033f6dbe
mkimage-profiles/features.in/README

43 lines
3.0 KiB
Plaintext
Raw Normal View History

added asciidoc support
2012-10-31 01:21:23 +04:00
== features.in ==
README update These have been proofread somewhat to correspond to the current state of affairs; a missing one was added for fonts feature.
2013-06-10 17:37:16 +04:00
features: hopefully better README 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).
2012-08-11 22:45:26 +04:00
Этот каталог содержит т.н. фичи (features, особенности).
docs day ToC: - introduced doc/ - features.in/00example/ - READMEs and TODO for more - code comments clarified Some unrelated minor fixes bundled either.
2010-09-22 01:58:24 +04:00
features: hopefully better README 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).
2012-08-11 22:45:26 +04:00
Фича -- отдельно подключаемая сущность, которая содержит
повторно используемые конфигурацию/код и определяет одну
из особенностей создаваемого образа. Может зависеть от
других фич либо субпрофилей.
Каждая фича должна содержать файл config.mk, включаемый
в ../main.mk при построении конфигурации будущего профиля;
он может описывать одну или более целей вида use/*,
дополняющих конфигурацию, и обязан добавить имя фичи
в $(FEATURES), для чего создана функция add_feature.
docs day ToC: - introduced doc/ - features.in/00example/ - READMEs and TODO for more - code comments clarified Some unrelated minor fixes bundled either.
2010-09-22 01:58:24 +04:00
full-view docs update - toplevel README received some long-needed refactoring + lowlevel detail moved, well, to lowlevel READMEs - reflected more thoroughly that m-p is not about distros anymore - dropped features.in/00example/README.en: it's already out-of-date a bit, and there's no perceived need in thorough English docs so far - wiki article got split into parts and somewhat rewritten, links updated - mv doc/{CodingStyle,style.txt}
2011-11-06 23:57:28 +04:00
На этапе генерации сборочного профиля фичи рассматриваются
docs day ToC: - introduced doc/ - features.in/00example/ - READMEs and TODO for more - code comments clarified Some unrelated minor fixes bundled either.
2010-09-22 01:58:24 +04:00
после инициализации профиля (см. ../image.in/) и копирования
README update reword 'em, structurize 'em, facelift 'em too
2011-07-20 22:45:28 +04:00
субпрофилей (см. ../sub.in/). Для каждой фичи, указанной
features: hopefully better README 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).
2012-08-11 22:45:26 +04:00
в $(FEATURES), копируются подкаталоги сообразно включенным
субпрофилям, а также lib/ и {image-,}scripts.d/; затем
выполняются generate.sh и generate.mk при их наличии.
features.in: tagged scripts support From now on a feature can contain this tree: . +- scripts.d/ +- image-scripts.d/ `- tagged/ +- scripts.d/ `- image-scripts.d/ ...per subprofile part or in its root -- the latter one gets merged into toplevel directory responsible for the final image build. NB: autoselected tags include only subprofile names (or both parts, for complex subprofiles) -- this is highly prone to change yet!
2011-09-13 20:15:42 +04:00
features.in/Makefile: src/dst tweaks Introduced support for hooks to be added to every derivative substage of a "base" stage (think stage2/*). Specific hooks for e.g. stage2/live would live in features.in/*/live/*scripts.d/ while generic for stage2/* in features.in/*/stage2/*scripts.d/
2011-09-11 17:08:31 +04:00
Если фича дополняет хуками семейство целевых субпрофилей,
построенных на одном базовом, можно воспользоваться подкаталогом
с именем исходного базового субпрофиля (см. $src, $dst в Makefile).
features.in: extended README a bit The script hook naming advice and "+name" puropose explanation seem to have been missing.
2012-12-20 16:16:55 +04:00
Рекомендуется давать несколько различающиеся имена скриптам,
которые одна и та же фича может добавлять в различные стадии,
чтобы они не выглядели одинаково в логе сборки.
features: hopefully better README 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).
2012-08-11 22:45:26 +04:00
Наиболее востребованные цели можно снабжать "ярлычками" вроде
initial "+shortcut" support and refactoring It looks like the intermediate targets aren't all equal: some define a finished feature while some create a common lower level piece of configuration. Let's do shortcuts for the former so that a distro line can be more terse and descriptive; help targets in features.in/ tweaked accordingly.
2012-03-16 22:26:58 +04:00
"+icewm" с тем, чтобы сделать более краткими и выразительными
features.in: extended README a bit The script hook naming advice and "+name" puropose explanation seem to have been missing.
2012-12-20 16:16:55 +04:00
использующие их правила. Просьба не злоупотреблять количеством,
такие имена предполагается показывать в интерфейсе к профилю.
initial "+shortcut" support and refactoring It looks like the intermediate targets aren't all equal: some define a finished feature while some create a common lower level piece of configuration. Let's do shortcuts for the former so that a distro line can be more terse and descriptive; help targets in features.in/ tweaked accordingly.
2012-03-16 22:26:58 +04:00
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
Каталог lib/ является специфическим для фич, определяющих
full-view docs update - toplevel README received some long-needed refactoring + lowlevel detail moved, well, to lowlevel READMEs - reflected more thoroughly that m-p is not about distros anymore - dropped features.in/00example/README.en: it's already out-of-date a bit, and there's no perceived need in thorough English docs so far - wiki article got split into parts and somewhat rewritten, links updated - mv doc/{CodingStyle,style.txt}
2011-11-06 23:57:28 +04:00
построение конкретного вида образа -- см. build-*/.
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
docs day ToC: - introduced doc/ - features.in/00example/ - READMEs and TODO for more - code comments clarified Some unrelated minor fixes bundled either.
2010-09-22 01:58:24 +04:00
Несложный пример содержится в 00example/, более близкий к жизни
и нынешним пределам возможностей метапрофиля -- в syslinux/.
README update These have been proofread somewhat to correspond to the current state of affairs; a missing one was added for fonts feature.
2013-06-10 17:37:16 +04:00
См. тж. файлы README в каталогах фич (отсутствие -- баг!).
Reference in New Issue Copy Permalink