Go to file
Michael Shigorin 9e03dee41c conf.d/README: be more concise
THE_KMODULES isn't referencing the actual *.ko files
but rather kernel-modules-* packages; it was a bit too
verbose to name *_KMODULES as *_KMODULE_PACKAGES even
if it was more self-explanatory of course, but still
we've got the first victim to that ambiguity.
2015-12-05 22:12:01 +03:00
.gear gear-store-tags 2015-11-30 23:44:49 +03:00
bin mktmpdir: fixed sort key 2015-09-07 21:01:14 +03:00
conf.d conf.d/README: be more concise 2015-12-05 22:12:01 +03:00
doc mkimage-profiles.asciidoc: index optimization 2015-05-05 15:58:43 +03:00
features.in stage2, lowmem: update cleanup hooks for qt5 2015-12-04 20:58:32 +03:00
image.in image.in, stage2: reworked TCB fixup hook 2015-11-16 20:24:25 +03:00
lib build.mk: drop an extra space 2015-11-30 16:49:52 +03:00
pkg.in regular.mk: a few netsec tools to the rescue 2015-12-05 13:32:38 +03:00
sub.in stage2, lowmem: update cleanup hooks for qt5 2015-12-04 20:58:32 +03:00
.gitignore kernel and BUILDDIR fixes 2011-11-04 16:15:29 +02:00
COPYING actually released as free software 2011-11-04 16:15:30 +02:00
main.mk main.mk: fix the help-related glitch 2015-06-03 13:31:38 +03:00
Makefile introduce QUIET variable 2015-04-02 20:48:42 +03:00
QUICKSTART QUICKSTART: mention BUILDDIR 2015-11-15 22:25:12 +03:00
README README: explained wiki link 2014-06-30 23:49:49 +04:00
reports.mk reports.mk: that space was extra 2014-06-04 19:09:11 +04:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Welcome to m-p! ==

*Brief summary*

  Configurables: ~/.mkimage/profiles.mk;
  see doc/params.txt and conf.d/README

  License: GPLv2+, see COPYING

  Most docs are in Russian, welcome to learn it or ask for English.

Задача:

* конфигурирование и создание образов на базе ALT Linux

Концепция:

* конфигурация, как и образ -- объект постадийной сборки
* метапрофиль служит репозиторием для построения индивидуального
  профиля, по которому создаётся итоговый образ

Особенности:

* метапрофиль при сборке может быть доступен только на чтение
* для сборки подыскивается предпочтительно tmpfs
* в профиль копируются только нужные объекты;
  он автономен относительно метапрофиля

Стадии работы:

* инициализация сборочного профиля
* сборка конфигурации образа
* наполнение сборочного профиля
* сборка образа

Объекты:

* дистрибутивы и виртуальные среды/машины:
** описываются в conf.d/*.mk
** могут основываться на предшественниках, расширяя их
** дистрибутивы также включают один или более субпрофилей по надобности
** желательно избегать множественного наследования, см. тж. фичи
* субпрофили:
** список собирается в $(SUBPROFILES)
** базовые комплекты помещены в подкаталогах под sub.in/;
   их наборы скриптов могут расширяться фичами
* фичи:
** законченные блоки функциональности (или наборы таковых)
** описываются в индивидуальных features.in/*/config.mk
** могут требовать другие фичи, а также субпрофили
** накопительный список собирается в $(FEATURES)
** при сборке $(BUILDDIR) содержимое фич добавляется в профиль
* списки пакетов (*_LISTS):
** просьба по возможности избегать дублирования (см. bin/pkgdups)
* индивидуальные пакеты (*_PACKAGES): см. тж. conf.d/README

Результат:

* при успешном завершении сборки образ называется по имени цели
  и укладывается в $(IMAGEDIR):
** указанный явно,
** либо ~/out/ (если возможно),
** или $(BUILDDIR)/out/ иначе
* формируются отчёты, если запрошены (REPORT)

См. тж.:

* http://altlinux.org/m-p: обзорная документация, в т.ч. howto
* doc/:
** params.txt: переменные, указываемые при запуске сборки
** pkglists.txt: формирование состава образа
** features.txt: обзор подключаемых особенностей

Примечание: пути в документации задаются от каталога верхнего уровня,
если не указаны как относительные в явном виде (./) или по смыслу.

Удачи; что не так -- пишите.

Michael Shigorin <mike@altlinux.org>