From 74d1e45a1c867c8f307a11b2cac922d97aad3ebd Mon Sep 17 00:00:00 2001 From: Michael Shigorin Date: Mon, 2 Apr 2012 18:13:14 +0300 Subject: [PATCH] docs update Status updates and readability tweaks all over the place. --- README | 9 +++++---- doc/assumptions.txt | 3 ++- doc/features.txt | 4 ++-- doc/profiles.mk.sample | 1 + features.in/00example/README | 5 +++++ features.in/install2/README | 3 ++- features.in/isohybrid/README | 9 ++++++--- features.in/ltsp/README | 2 +- features.in/x11/README | 3 ++- image.in/README | 6 +++--- pkg.in/lists/README | 4 ++-- pkg.in/lists/tagged/README | 12 ++++++------ sub.in/main/README | 2 +- 13 files changed, 38 insertions(+), 25 deletions(-) diff --git a/README b/README index 242e9453..86781906 100644 --- a/README +++ b/README @@ -1,12 +1,12 @@ 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). 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. См. тж. 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 - + могут основываться одно на другом + + могут основываться на предшественниках, расширяя их + дистрибутивы также: - включают один или более субпрофилей по надобности + желательно избегать множественного наследования, см. тж. фичи @@ -58,3 +58,4 @@ Most docs are in Russian, welcome to learn it or ask for English. + указанный явно, + либо ~/out/ (если возможно), + или $(BUILDDIR)/out/ иначе +- формируются отчёты, если запрошены (REPORTS) diff --git a/doc/assumptions.txt b/doc/assumptions.txt index 9e88425a..fe678c51 100644 --- a/doc/assumptions.txt +++ b/doc/assumptions.txt @@ -1,7 +1,8 @@ предположения фрагментов кода об окружении ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ NB: пути приводятся от верхнего уровня; проект в целом предполагает -GNU make 3.81 (с использованием которого и разрабатывается). +ALT Linux 6.0+ и GNU make 3.81 (на которых и разрабатывается), +но может быть портирован вместе с mkimage. - lib/report.mk + ожидает, что каждая подлежащая трассированию цель каждого diff --git a/doc/features.txt b/doc/features.txt index 6d349337..ff3471b8 100644 --- a/doc/features.txt +++ b/doc/features.txt @@ -2,7 +2,7 @@ ~~~~ Особенности дистрибутива, не учитываемые в пакетной базе или зависящие от переменных времени сборки/установки образа, -могут быть оформлены несколькими образами: +могут быть оформлены как: * scripts.d/ или image-scripts.d/ различных стадий; * пакеты installer-feature-* @@ -10,7 +10,7 @@ В большинстве случаев можно рекомендовать создание feature средствами метапрофиля, поскольку при этом дерево кода более -удобно для анализа и обновления (и в отличие от m-p-d, нет +удобно для анализа и обновления (и в отличие от m-p-d -- нет вынужденной необходимости либо контролировать включение нужных фич "вручную" в скриптах по косвенным признакам, либо выносить их в пакеты installer-feature-*). diff --git a/doc/profiles.mk.sample b/doc/profiles.mk.sample index 63845227..4e3f7e6a 100644 --- a/doc/profiles.mk.sample +++ b/doc/profiles.mk.sample @@ -1,4 +1,5 @@ # 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 #APTCONF = ~/apt/apt.conf.$(ARCH) diff --git a/features.in/00example/README b/features.in/00example/README index 4c002a8d..bc8801f1 100644 --- a/features.in/00example/README +++ b/features.in/00example/README @@ -15,6 +15,11 @@ в списке, содержащемся в этой переменной, то она не задействуется при построении профиля, а только при сборке конфигурации. +Для наиболее ходовых целей use/*, особенно если их много, можно +создавать цели-алиасы +* (например, +power). Просьба относиться +вдумчиво, т.к. в дальнейшем предполагается визуализировать такие +цели в UI конфигурирования образа. + Остальное содержимое является дополнительным и используется в таком порядке (см. ../Makefile): diff --git a/features.in/install2/README b/features.in/install2/README index 3ff77d7e..16141938 100644 --- a/features.in/install2/README +++ b/features.in/install2/README @@ -6,4 +6,5 @@ чтобы в компактном livecd, которым является инсталятор, оказались нужные им утилиты (INSTALL2_PACKAGES). Перегружать его не следует, поскольку это прямо влияет на требования по минимальному размеру -оперативной памяти для установки. +оперативной памяти для установки (если не задействован параметр +загрузки ядра lowmem, обрабатываемый propagator). diff --git a/features.in/isohybrid/README b/features.in/isohybrid/README index 2d2480ec..fe91699f 100644 --- a/features.in/isohybrid/README +++ b/features.in/isohybrid/README @@ -3,7 +3,10 @@ так и с USB-флэшки. Можно указать в цепочке зависимостей дистрибутива явно с тем, -чтобы гарантировать гибридный вид образа; в экспериментальном -порядке сделана возможность запросить включение этой фичи при -сборке конфигурации произвольного дистрибутива +чтобы гарантировать гибридный вид образа, либо запросить включение +этой фичи при сборке конфигурации произвольного дистрибутива (ISOHYBRID=1, см. ../pack/config.mk). + +Обратите внимание: в propagator до 20101130-alt15 поддержка +автоматической загрузки с флэш-носителя и при этом ISO-образа +отсутствует, что компенсируется специальной обработкой в gfxboot. diff --git a/features.in/ltsp/README b/features.in/ltsp/README index 24afcdeb..1a163fb9 100644 --- a/features.in/ltsp/README +++ b/features.in/ltsp/README @@ -2,4 +2,4 @@ - загрузку бездисковых тонких клиентов по сети; - предоставление им доступа к серверу приложений. -На данный момент является совсем экспериментальной. +На данный момент является экспериментальной. diff --git a/features.in/x11/README b/features.in/x11/README index 5f2a34ad..90f6149e 100644 --- a/features.in/x11/README +++ b/features.in/x11/README @@ -1 +1,2 @@ -Эта фича добавляет базовую поддержку графической системы X11. +Эта фича добавляет базовую поддержку графической системы X11 +и комплектует типовые десктопные окружения. diff --git a/image.in/README b/image.in/README index 8d39c533..59199d49 100644 --- a/image.in/README +++ b/image.in/README @@ -1,11 +1,11 @@ Этот каталог копируется из метапрофиля в профиль "как есть" -и формирует "затравку" финальной стадии, собирающей собственно +и формирует "заготовку" финальной стадии, собирающей собственно образ из результатов работы индивидуальных субпрофилей (для distro/*) либо непосредственно "на месте" (для ve/*). Содержимое files/ копируется в корень образа. -Соответственно для сборки требуется или features.in/build-distro, -или use/build-ve. +Соответственно для сборки также потребуется или +../features.in/build-distro, или ../features.in/build-ve. Пакетная база рабочего чрута минимальна (может чуть расширяться фичами -- см. ../features.in/repo/lib/build-genbasedir.mk diff --git a/pkg.in/lists/README b/pkg.in/lists/README index 5dba653a..9aa04c26 100644 --- a/pkg.in/lists/README +++ b/pkg.in/lists/README @@ -6,5 +6,5 @@ см. http://www.altlinux.org/Alterator-pkg); он создаётся из содержимого ряда переменных (см. Makefile). -Подкаталог tagged/ стоит рассматривать как экспериментальный, -но находящий всё более широкое практическое использование. +Подкаталог tagged/ содержит тегированные списки, имена которых +удобно получать функцией tags() (см. ../../lib/functions.mk). diff --git a/pkg.in/lists/tagged/README b/pkg.in/lists/tagged/README index 3c2f72e4..be71f391 100644 --- a/pkg.in/lists/tagged/README +++ b/pkg.in/lists/tagged/README @@ -1,12 +1,12 @@ Этот каталог содержит тегированные списки; на данный момент -реализация (tags2lists) требует, чтобы каждый из тегов был -отдельным словом, состоящим из символов из набора a-zA-Z0-9_ -(внимание: не используйте в слове "-"); рекомендуется +реализация (../../../bin/tags2lists) требует, чтобы каждый +из тегов был отдельным словом, состоящим из символов из набора +a-zA-Z0-9_ (внимание: не используйте в слове "-"); рекомендуется разделять слова "+". -Предположительное применение: дополнение функциональности, -заданной статически (наследственно или явно), факультативным -результатом раскрытия списка тегов; в первую очередь contrib? +Применение: дополнение жёстко статически заданной функциональности +более "плавающим" в долгосрочном плане результатом раскрытия +списка тегов. Реализация является экспериментальной и требует утряски с ../groups/; комментарии и помощь всячески приветствуются. diff --git a/sub.in/main/README b/sub.in/main/README index 978a6ed4..2d71b0ef 100644 --- a/sub.in/main/README +++ b/sub.in/main/README @@ -12,6 +12,6 @@ рабочий чрут не содержит исполняемых файлов. Не следует использовать этот субпрофиль напрямую, для добавления -пакетного репозитория в образ предназначена фича repo/main. +пакетного репозитория в образ предназначена фича use/repo/main. Результат -- каталог ALTLinux/RPMS.main для копирования в образ.