From fba30e0675f9ddc7e1245d5f049ba01a1f1d08f9 Mon Sep 17 00:00:00 2001 From: Michael Shigorin Date: Sat, 3 Sep 2011 12:17:26 +0300 Subject: [PATCH] docs update Rather minor fixups for things changed in the meanwhile and not yet (re)documented properly; and a change for memtest feature to require syslinux feature (the code's been changed to fit the updated description, actually, and the change is purely formal as no syslinux alternative is being used/planned so far). --- doc/features.txt | 4 ++++ features.in/00example/README | 9 +++++---- features.in/bootloader/README | 2 +- features.in/memtest/README | 5 +---- features.in/memtest/config.mk | 2 +- image.in/README | 3 +-- pkg.in/lists/README | 8 +++----- sub.in/stage1/README | 9 ++++----- sub.in/stage2/README | 10 +++++----- 9 files changed, 25 insertions(+), 27 deletions(-) diff --git a/doc/features.txt b/doc/features.txt index ed742ff2..42d2a536 100644 --- a/doc/features.txt +++ b/doc/features.txt @@ -19,3 +19,7 @@ * требуется компилируемый платформозависимый код (для чего бы...); * код фичи достаточно специфичен, нетривиален и объёмен, чтобы загромождать метапрофиль было не очень осмысленно. + +Стоит избегать изменения пакетных умолчаний в случае, когда их +представляется осмысленным и возможным скорректировать в пакете: +таким образом они станут более дистрибутивными. diff --git a/features.in/00example/README b/features.in/00example/README index 7a51441d..a9839141 100644 --- a/features.in/00example/README +++ b/features.in/00example/README @@ -14,7 +14,8 @@ её в переменную FEATURES -- к сожалению, реализовать добавление автоматом не представляется возможным). Если название фичи не упоминается в списке, содержащемся в этой переменной, то она -и не задействуется при построении профиля. +не задействуется при построении профиля, а только при сборке +конфигурации дистрибутива. Остальное содержимое является дополнительным и используется в таком порядке (см. features.in/Makefile): @@ -31,11 +32,11 @@ - затем используется generate.mk, если существует и непустой. -Например, если дистрибутив требует субпрофили stage1, install2 +Например, если используются субпрофили stage1, stage2/install2 и main, вы можете решить собрать специфические для фичи скрипты инсталятора в install2/image-scripts.d/ (или необходимые для -операций с пакетной базой -- в main/scripts.d/, смотря чего надо -добиться; загляните также в документацию mkimage). +операций с пакетной базой -- в main/scripts.d/, смотря чего +надо добиться; загляните также в документацию mkimage). А если требуются нетривиальные действия по конфигурированию (как при сборке syslinux.cfg из кусочков, в зависимости от того, diff --git a/features.in/bootloader/README b/features.in/bootloader/README index 96dd51d9..3ae37407 100644 --- a/features.in/bootloader/README +++ b/features.in/bootloader/README @@ -6,4 +6,4 @@ и требует пакет выбранного загрузчика. Реализация экспериментальная (нужно модуляризовать installer-steps), -завязана на installer-distro-altlinux-generic = 6.0-alt2. +пока завязана на installer-distro-altlinux-generic. diff --git a/features.in/memtest/README b/features.in/memtest/README index f26954ca..c6fbac88 100644 --- a/features.in/memtest/README +++ b/features.in/memtest/README @@ -1,5 +1,2 @@ Добавление memtest86+ в загрузку с образа и в устанавливаемую пакетную базу; -востребовано для для инсталяторов, live/rescue. - -NB: интегрируется с syslinux (проверено/работает), но _не_ требует -use/syslinux на случай, если прикрутим поддержку других загрузчиков. +востребовано для для инсталяторов, live/rescue. Интегрируется с syslinux. diff --git a/features.in/memtest/config.mk b/features.in/memtest/config.mk index f223b3a5..1fe478b5 100644 --- a/features.in/memtest/config.mk +++ b/features.in/memtest/config.mk @@ -1,4 +1,4 @@ -use/memtest: +use/memtest: use/syslinux @$(call add,FEATURES,memtest) @$(call add,COMMON_PACKAGES,memtest86+) @$(call add,SYSLINUX_CFG,memtest) diff --git a/image.in/README b/image.in/README index 33d920d1..b6d8dda5 100644 --- a/image.in/README +++ b/image.in/README @@ -1,7 +1,6 @@ Этот каталог копируется из метапрофиля в профиль "как есть" и формирует "затравку", собирающую собственно образ из результатов -работы индивидуальных субпрофилей (в т.ч. стадий инсталятора, -см. ../sub.in/). +работы индивидуальных субпрофилей (см. ../sub.in/). Содержимое files/ копируется в корень образа. diff --git a/pkg.in/lists/README b/pkg.in/lists/README index 86bb0049..5dba653a 100644 --- a/pkg.in/lists/README +++ b/pkg.in/lists/README @@ -3,10 +3,8 @@ имён списков в переменных *_LISTS, см. реализацию в Makefile). Список .base является особенным (формирует базовую систему, -см. http://www.altlinux.org/Alterator-pkg) и копируется безусловно. -Это предполагается изменить в будущем -- возможно, генерацией .base -по тегам. +см. http://www.altlinux.org/Alterator-pkg); он создаётся из +содержимого ряда переменных (см. Makefile). Подкаталог tagged/ стоит рассматривать как экспериментальный, -хотя весь необходимый код уже на месте -- см. bin/tags2lists -и distro.mk (в корневом каталоге). +но находящий всё более широкое практическое использование. diff --git a/sub.in/stage1/README b/sub.in/stage1/README index 02815a07..477b9c23 100644 --- a/sub.in/stage1/README +++ b/sub.in/stage1/README @@ -2,9 +2,9 @@ здесь место syslinux (загрузчик) и propagator (ориентировка на местности, вытягивание второй стадии с CD/FTP/...). -Скрипты обычно запускаются извне формируемого образа, -т.е. это scripts.d/; следует крайне бережно относиться -к составу STAGE1_PACKAGES и объёму этой стадии. +Скрипты запускаются извне формируемого образа (scripts.d/); +следует крайне бережно относиться к составу STAGE1_PACKAGES +и объёму этой стадии. Обратите внимание: если не указать явно требуемый вариант ядра посредством STAGE1_KFLAVOUR, будет взят последний @@ -15,5 +15,4 @@ STAGE1_KMODULES_REGEXP -- будет подмножество модулей Требуется для инсталяционных, live- и rescue-образов. -Результат -- каталог syslinux/, подлежащий копированию -в образ. +Результат -- каталог syslinux/ для копирования в образ. diff --git a/sub.in/stage2/README b/sub.in/stage2/README index 1d45c8f4..9cc36be8 100644 --- a/sub.in/stage2/README +++ b/sub.in/stage2/README @@ -1,6 +1,6 @@ -Этот каталог содержит общий субпрофиль "живой" второй стадии, -используемой в качестве базы для сборки образов install2, live, rescue -(возможно, нескольких одновременно в составе одного дистрибутива). +Этот каталог содержит общий базовый субпрофиль "живой" второй стадии, +используемый для сборки образов install2, live, rescue (возможно, +нескольких одновременно в составе одного дистрибутива). -Результат -- squashfs в названном сообразно варианту файле, -подлежащем копированию в итоговый образ. +Результат -- соответственно названный файл со squashfs, +подлежащий копированию в итоговый образ.