mkimage-profiles

Go to file

Michael Shigorin e0004a2621 added docs-publish toplevel goal This one is long overdue as I keep forgetting to update the published copy of generated documentation all the time. Note that you must pass DOCS_PUBLISH (as a local directory or host:dir suitable for rsync/ssh) via make arguments, environment or ~/.mkimage/profiles.mk file.		2014-06-24 15:29:10 +04:00
.gear	gear-store-tags	2014-06-16 17:39:12 +04:00
bin	tar2vm: use UUID, prepare for virtio as well	2014-03-20 19:46:53 +04:00
conf.d	regular.mk: kludge to ensure nm-applet is around	2014-06-12 18:10:31 +04:00
doc	added docs-publish toplevel goal	2014-06-24 15:29:10 +04:00
features.in	net: 50-net-nm band-aid	2014-06-12 18:19:59 +04:00
image.in	documentation: use paths relative to toplevel dir	2014-03-05 21:36:30 +04:00
lib	documentation: use paths relative to toplevel dir	2014-03-05 21:36:30 +04:00
pkg.in	rescue+extra: added lnav	2014-06-23 16:06:27 +04:00
sub.in	kernel, stage1: don't provide r8168.ko by default	2014-03-17 21:22:29 +04: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: target refactoring	2013-06-20 13:42:20 +04:00
Makefile	added docs-publish toplevel goal	2014-06-24 15:29:10 +04:00
QUICKSTART	QUICKSTART: added howto reference	2014-06-02 20:45:41 +04:00
README	documentation: use paths relative to toplevel dir	2014-03-05 21:36:30 +04:00
reports.mk	reports.mk: that space was extra	2014-06-04 19:09:11 +04:00

README

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
* doc/:
** params.txt: переменные, указываемые при запуске сборки
** pkglists.txt: формирование состава образа
** features.txt: обзор подключаемых особенностей

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

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

Michael Shigorin <mike@altlinux.org>

README Unescape Escape

README