docs update

Status updates and readability tweaks all over the place.
This commit is contained in:
Michael Shigorin 2012-04-02 18:13:14 +03:00
parent dccf9a58b5
commit 74d1e45a1c
13 changed files with 38 additions and 25 deletions

9
README
View File

@ -1,12 +1,12 @@
Welcome to mkimage-profiles! Welcome to mkimage-profiles!
English quickstart: make distro/server-base.iso; English quickstart: make server-mini.iso;
see http://en.altlinux.org/Hasher (and a large tmpfs). see http://en.altlinux.org/Hasher (and a large tmpfs).
Configurables: ~/.mkimage/profiles.mk; Configurables: ~/.mkimage/profiles.mk;
see doc/profiles.mk.sample and libdistro.mk see doc/variables.txt and conf.d/README
License: GPLv2+, see COPYING. License: GPLv2+, see COPYING
Most docs are in Russian, welcome to learn it or ask for English. Most docs are in Russian, welcome to learn it or ask for English.
См. тж. http://www.altlinux.org/Mkimage/Profiles/m-p См. тж. http://www.altlinux.org/Mkimage/Profiles/m-p
@ -34,7 +34,7 @@ Most docs are in Russian, welcome to learn it or ask for English.
Объекты: Объекты:
- дистрибутивы и виртуальные окружения: - дистрибутивы и виртуальные окружения:
+ описываются в conf.d/*.mk или соответственно lib/{distro,ve}.mk + описываются в conf.d/*.mk или соответственно lib/{distro,ve}.mk
+ могут основываться одно на другом + могут основываться на предшественниках, расширяя их
+ дистрибутивы также: + дистрибутивы также:
- включают один или более субпрофилей по надобности - включают один или более субпрофилей по надобности
+ желательно избегать множественного наследования, см. тж. фичи + желательно избегать множественного наследования, см. тж. фичи
@ -58,3 +58,4 @@ Most docs are in Russian, welcome to learn it or ask for English.
+ указанный явно, + указанный явно,
+ либо ~/out/ (если возможно), + либо ~/out/ (если возможно),
+ или $(BUILDDIR)/out/ иначе + или $(BUILDDIR)/out/ иначе
- формируются отчёты, если запрошены (REPORTS)

View File

@ -1,7 +1,8 @@
предположения фрагментов кода об окружении предположения фрагментов кода об окружении
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
NB: пути приводятся от верхнего уровня; проект в целом предполагает NB: пути приводятся от верхнего уровня; проект в целом предполагает
GNU make 3.81 (с использованием которого и разрабатывается). ALT Linux 6.0+ и GNU make 3.81 (на которых и разрабатывается),
но может быть портирован вместе с mkimage.
- lib/report.mk - lib/report.mk
+ ожидает, что каждая подлежащая трассированию цель каждого + ожидает, что каждая подлежащая трассированию цель каждого

View File

@ -2,7 +2,7 @@
~~~~ ~~~~
Особенности дистрибутива, не учитываемые в пакетной базе Особенности дистрибутива, не учитываемые в пакетной базе
или зависящие от переменных времени сборки/установки образа, или зависящие от переменных времени сборки/установки образа,
могут быть оформлены несколькими образами: могут быть оформлены как:
* scripts.d/ или image-scripts.d/ различных стадий; * scripts.d/ или image-scripts.d/ различных стадий;
* пакеты installer-feature-* * пакеты installer-feature-*
@ -10,7 +10,7 @@
В большинстве случаев можно рекомендовать создание feature В большинстве случаев можно рекомендовать создание feature
средствами метапрофиля, поскольку при этом дерево кода более средствами метапрофиля, поскольку при этом дерево кода более
удобно для анализа и обновления (и в отличие от m-p-d, нет удобно для анализа и обновления (и в отличие от m-p-d -- нет
вынужденной необходимости либо контролировать включение нужных вынужденной необходимости либо контролировать включение нужных
фич "вручную" в скриптах по косвенным признакам, либо выносить фич "вручную" в скриптах по косвенным признакам, либо выносить
их в пакеты installer-feature-*). их в пакеты installer-feature-*).

View File

@ -1,4 +1,5 @@
# sample ~/.mkimage/profiles.mk # sample ~/.mkimage/profiles.mk
# NB: REPORT doesn't work here, it's somewhat special
# where to look for apt.conf; system one used by default # where to look for apt.conf; system one used by default
#APTCONF = ~/apt/apt.conf.$(ARCH) #APTCONF = ~/apt/apt.conf.$(ARCH)

View File

@ -15,6 +15,11 @@
в списке, содержащемся в этой переменной, то она не задействуется в списке, содержащемся в этой переменной, то она не задействуется
при построении профиля, а только при сборке конфигурации. при построении профиля, а только при сборке конфигурации.
Для наиболее ходовых целей use/*, особенно если их много, можно
создавать цели-алиасы +* (например, +power). Просьба относиться
вдумчиво, т.к. в дальнейшем предполагается визуализировать такие
цели в UI конфигурирования образа.
Остальное содержимое является дополнительным и используется Остальное содержимое является дополнительным и используется
в таком порядке (см. ../Makefile): в таком порядке (см. ../Makefile):

View File

@ -6,4 +6,5 @@
чтобы в компактном livecd, которым является инсталятор, оказались чтобы в компактном livecd, которым является инсталятор, оказались
нужные им утилиты (INSTALL2_PACKAGES). Перегружать его не следует, нужные им утилиты (INSTALL2_PACKAGES). Перегружать его не следует,
поскольку это прямо влияет на требования по минимальному размеру поскольку это прямо влияет на требования по минимальному размеру
оперативной памяти для установки. оперативной памяти для установки (если не задействован параметр
загрузки ядра lowmem, обрабатываемый propagator).

View File

@ -3,7 +3,10 @@
так и с USB-флэшки. так и с USB-флэшки.
Можно указать в цепочке зависимостей дистрибутива явно с тем, Можно указать в цепочке зависимостей дистрибутива явно с тем,
чтобы гарантировать гибридный вид образа; в экспериментальном чтобы гарантировать гибридный вид образа, либо запросить включение
порядке сделана возможность запросить включение этой фичи при этой фичи при сборке конфигурации произвольного дистрибутива
сборке конфигурации произвольного дистрибутива
(ISOHYBRID=1, см. ../pack/config.mk). (ISOHYBRID=1, см. ../pack/config.mk).
Обратите внимание: в propagator до 20101130-alt15 поддержка
автоматической загрузки с флэш-носителя и при этом ISO-образа
отсутствует, что компенсируется специальной обработкой в gfxboot.

View File

@ -2,4 +2,4 @@
- загрузку бездисковых тонких клиентов по сети; - загрузку бездисковых тонких клиентов по сети;
- предоставление им доступа к серверу приложений. - предоставление им доступа к серверу приложений.
На данный момент является совсем экспериментальной. На данный момент является экспериментальной.

View File

@ -1 +1,2 @@
Эта фича добавляет базовую поддержку графической системы X11. Эта фича добавляет базовую поддержку графической системы X11
и комплектует типовые десктопные окружения.

View File

@ -1,11 +1,11 @@
Этот каталог копируется из метапрофиля в профиль "как есть" Этот каталог копируется из метапрофиля в профиль "как есть"
и формирует "затравку" финальной стадии, собирающей собственно и формирует "заготовку" финальной стадии, собирающей собственно
образ из результатов работы индивидуальных субпрофилей образ из результатов работы индивидуальных субпрофилей
(для distro/*) либо непосредственно "на месте" (для ve/*). (для distro/*) либо непосредственно "на месте" (для ve/*).
Содержимое files/ копируется в корень образа. Содержимое files/ копируется в корень образа.
Соответственно для сборки требуется или features.in/build-distro, Соответственно для сборки также потребуется или
или use/build-ve. ../features.in/build-distro, или ../features.in/build-ve.
Пакетная база рабочего чрута минимальна (может чуть расширяться Пакетная база рабочего чрута минимальна (может чуть расширяться
фичами -- см. ../features.in/repo/lib/build-genbasedir.mk фичами -- см. ../features.in/repo/lib/build-genbasedir.mk

View File

@ -6,5 +6,5 @@
см. http://www.altlinux.org/Alterator-pkg); он создаётся из см. http://www.altlinux.org/Alterator-pkg); он создаётся из
содержимого ряда переменных (см. Makefile). содержимого ряда переменных (см. Makefile).
Подкаталог tagged/ стоит рассматривать как экспериментальный, Подкаталог tagged/ содержит тегированные списки, имена которых
но находящий всё более широкое практическое использование. удобно получать функцией tags() (см. ../../lib/functions.mk).

View File

@ -1,12 +1,12 @@
Этот каталог содержит тегированные списки; на данный момент Этот каталог содержит тегированные списки; на данный момент
реализация (tags2lists) требует, чтобы каждый из тегов был реализация (../../../bin/tags2lists) требует, чтобы каждый
отдельным словом, состоящим из символов из набора a-zA-Z0-9_ из тегов был отдельным словом, состоящим из символов из набора
(внимание: не используйте в слове "-"); рекомендуется a-zA-Z0-9_ (внимание: не используйте в слове "-"); рекомендуется
разделять слова "+". разделять слова "+".
Предположительное применение: дополнение функциональности, Применение: дополнение жёстко статически заданной функциональности
заданной статически (наследственно или явно), факультативным более "плавающим" в долгосрочном плане результатом раскрытия
результатом раскрытия списка тегов; в первую очередь contrib? списка тегов.
Реализация является экспериментальной и требует утряски Реализация является экспериментальной и требует утряски
с ../groups/; комментарии и помощь всячески приветствуются. с ../groups/; комментарии и помощь всячески приветствуются.

View File

@ -12,6 +12,6 @@
рабочий чрут не содержит исполняемых файлов. рабочий чрут не содержит исполняемых файлов.
Не следует использовать этот субпрофиль напрямую, для добавления Не следует использовать этот субпрофиль напрямую, для добавления
пакетного репозитория в образ предназначена фича repo/main. пакетного репозитория в образ предназначена фича use/repo/main.
Результат -- каталог ALTLinux/RPMS.main для копирования в образ. Результат -- каталог ALTLinux/RPMS.main для копирования в образ.