Skip to content

Commit

Permalink
Include README of features to documentation; fix syntax & links in them
Browse files Browse the repository at this point in the history
  • Loading branch information
antohami committed Mar 18, 2023
1 parent ec1f948 commit 363ba22
Show file tree
Hide file tree
Showing 85 changed files with 416 additions and 27 deletions.
168 changes: 168 additions & 0 deletions doc/mkimage-profiles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,174 @@ include::../image.in/README[]

include::../features.in/README[]

include::../features.in/00example/README[]

include::../features.in/apt-conf/README[]

include::../features.in/armh-mcom02/README[]

include::../features.in/arm-rpi4/README[]

include::../features.in/bootloader/README[]

include::../features.in/branding/README[]

include::../features.in/browser/README[]

include::../features.in/build-distro/README[]

include::../features.in/build-ve/README[]

include::../features.in/build-vm/README[]

include::../features.in/cleanup/README[]

include::../features.in/control/README[]

include::../features.in/deflogin/README[]

include::../features.in/dev/README[]

include::../features.in/docs/README[]

include::../features.in/domain-client/README[]

include::../features.in/dos/README[]

include::../features.in/drm/README[]

include::../features.in/e2k/README[]

include::../features.in/efi/README[]

include::../features.in/firmware/README[]

include::../features.in/fonts/README[]

include::../features.in/gitlab-runner/README[]

include::../features.in/grub/README[]

include::../features.in/hdt/README[]

include::../features.in/homeros/README[]

include::../features.in/im/README[]

include::../features.in/initrd-bootchain/README[]

include::../features.in/initrd-propagator/README[]

include::../features.in/init/README[]

include::../features.in/install2/README[]

include::../features.in/isohybrid/README[]

include::../features.in/kernel/README[]

include::../features.in/l10n/README[]

include::../features.in/ldm/README[]

include::../features.in/live-install/README[]

include::../features.in/live/README[]

include::../features.in/lowmem/README[]

include::../features.in/ltsp/README[]

include::../features.in/luks/README[]

include::../features.in/lxc-guest/README[]

include::../features.in/lxc/README[]

include::../features.in/mediacheck/README[]

include::../features.in/memclean/README[]

include::../features.in/memtest/README[]

include::../features.in/metadata/README[]

include::../features.in/mipsel-bfk3/README[]

include::../features.in/mipsel-mitx/README[]

include::../features.in/net-dns/README[]

include::../features.in/net-eth/README[]

include::../features.in/net/README[]

include::../features.in/net-ssh/README[]

include::../features.in/net-usershares/README[]

include::../features.in/no-sleep/README[]

include::../features.in/ntp/README[]

include::../features.in/oem/README[]

include::../features.in/office/README[]

include::../features.in/pack/README[]

include::../features.in/pid1/README[]

include::../features.in/pkgpriorities/README[]

include::../features.in/plymouth/README[]

include::../features.in/power/README[]

include::../features.in/relname/README[]

include::../features.in/repo/README[]

include::../features.in/rescue/README[]

include::../features.in/server/README[]

include::../features.in/services/README[]

include::../features.in/slinux/README[]

include::../features.in/sound/README[]

include::../features.in/speech/README[]

include::../features.in/stage2/README[]

include::../features.in/syslinux/README[]

include::../features.in/tty/README[]

include::../features.in/uboot/README[]

include::../features.in/uuid-iso/README[]

include::../features.in/vagrant/README[]

include::../features.in/vmguest/README[]

include::../features.in/volumes/README[]

include::../features.in/wireless/README[]

include::../features.in/x11-autologin/README[]

include::../features.in/x11-autostart/README[]

include::../features.in/x11/README[]

include::../features.in/x11-vnc/README[]

include::../features.in/xdg-user-dirs/README[]

include::../sub.in/README[]

include::../sub.in/main/README[]
Expand Down
2 changes: 2 additions & 0 deletions features.in/00example/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/00example ===

Этот каталог содержит "заготовку" фичи в качестве примера
и должен дать представление о том, какой код _может_ быть
включён в настоящую фичу: статические файлы, два makefile
Expand Down
2 changes: 2 additions & 0 deletions features.in/apt-conf/README
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
=== features.in/apt-conf ===

Данная фича определяет то, какая конфигурация apt попадёт в образ.
4 changes: 3 additions & 1 deletion features.in/arm-rpi4/README
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
Настраивает систему для Raspberry Pi 4
=== features.in/arm-rpi4 ===

Настраивает систему для Raspberry Pi 4.

6 changes: 5 additions & 1 deletion features.in/armh-mcom02/README
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
=== features.in/armh-mcom02 ===

Фича предназначена для обеспечения поддержки процессорного модуля
"ЭЛВИС Салют ЭЛ24ПМ2". Подробнее: http://altlinux.org/mcom02
"ЭЛВИС Салют ЭЛ24ПМ2".

Подробнее: https://altlinux.org/mcom02
2 changes: 2 additions & 0 deletions features.in/bootloader/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/bootloader ===

Добавление установки загрузчика основной системы, затребованного
посредством указания "grub", "lilo" или "uboot" в BASE_BOOTLOADER.

Expand Down
4 changes: 3 additions & 1 deletion features.in/branding/README
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
=== features.in/branding ===

Эта фича врезается в makefile субпрофилей и обеспечивает
добавление задающих внешний вид и сообщения дистрибутива
пакетов; см. тж. http://www.altlinux.org/Branding
пакетов; см. тж. https://www.altlinux.org/Branding

Реализация "двумерная" -- отдельно задаётся BRANDING
(см. пакеты branding-*-%version-%release.src.rpm),
Expand Down
2 changes: 2 additions & 0 deletions features.in/browser/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/browser ===

Эта фича обеспечивает наличие и конкретизацию выбора браузера.
Разумеется, дополнительные варианты могут быть установлены
явным или косвенным затребованием.
Expand Down
2 changes: 2 additions & 0 deletions features.in/build-distro/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/build-distro ===

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

Expand Down
2 changes: 2 additions & 0 deletions features.in/build-ve/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/build-ve ===

Эта фича конфигурирует создание образа виртуального окружения (VE),
что используется для сборки шаблонов OpenVZ и ARM-чрутов для TWRP.

Expand Down
2 changes: 2 additions & 0 deletions features.in/build-vm/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/build-vm ===

Эта фича конфигурирует создание образа виртуальной машины (VM)
или тарбола rootfs для использования его на реальном компьютере.
Дополняет финальную стадию сборки (lib/, image-scripts.d/).
Expand Down
4 changes: 3 additions & 1 deletion features.in/cleanup/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/cleanup ===

Эта фича вместо созидания занимается выкидыванием лишнего
(например, части модулей инсталятора из установленной системы).

Expand All @@ -12,5 +14,5 @@ CLEANUP_BASE_PACKAGES.
Для удаления пакетов только из livecd используйте переменную
CLEANUP_LIVE_PACKAGES.

ВНИМАНИЕ: также удаляет rpm, apt и базу по пакетам из livecd,
CAUTION: также удаляет rpm, apt и базу по пакетам из livecd,
если в него не был добавлен инсталятор!
8 changes: 7 additions & 1 deletion features.in/control/README
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
=== features.in/control ===

Эта фича предоставляет интерфейс для конфигурирования дистрибутивных
значений по умолчанию control(8); см. тж. http://altlinux.org/control
значений по умолчанию control(8).

См. тж.:

https://www.altlinux.org/Control
8 changes: 5 additions & 3 deletions features.in/deflogin/README
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
=== features.in/deflogin ===

Эта фича конфигурирует root login и пользователей по умолчанию.

Если ROOTPW не задан, то подходящий пароль не существует.
При необходимости задать пустой пароль root (например, на LiveCD)
выставьте переменную ROOTPW_EMPTY в значение "1".

ВНИМАНИЕ: применяйте разумно, т.к. крайне легко создать и оставить
CAUTION: применяйте разумно, т.к. крайне легко создать и оставить
дыру в безопасности!

В версии mkimage-profiles 1.4.4 появилась возможность создать пользователя
с произвольными uid, gid, домашним каталогом, интерпретатором shell и т.д.
Используйте для этого следующую конструкцию:

@$(call set,SPEC_USER,имя_пользователя:группа:uid:gid:home_dir:shell)
@$(call set,SPEC_USER,имя_пользователя:группа:uid:gid:home_dir:shell)

Например:

@$(call set,SPEC_USER,user:user:500:500:/home/user:/bin/bash)
@$(call set,SPEC_USER,user:user:500:500:/home/user:/bin/bash)

При этом нужно иметь в виду, что будет создана соответствующая группа с
соответствующим gid (нужно быть уверенным, что одноимённая группа не сущетсвует),
Expand Down
2 changes: 2 additions & 0 deletions features.in/dev/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/dev ===

Эта фича служит для создания образов, предназначающихся для разработки.
В первую очередь обеспечивается развёртывание hasher и mkimage.

Expand Down
4 changes: 3 additions & 1 deletion features.in/docs/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/docs ===

Эта фича добавляет в образ распакованную документацию дистрибутива,
а именно вводную страничку (входит в пакет branding-*-indexhtml),
и/или специфичное для данного продукта руководство из пакета docs-*
Expand All @@ -8,5 +10,5 @@
языка (при наличии index-LL.html), поэтому ожидается задействование
фичи l10n с соответствующим указанием языка по умолчанию.

NB: предполагается применение при формировании ISO-образов,
NOTE: предполагается применение при формировании ISO-образов,
другие случаи наверняка потребуют доработки.
4 changes: 3 additions & 1 deletion features.in/domain-client/README
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
=== features.in/domain-client ===

Эта фича конфигурирует поддержку клиента домена ALT Linux.

krb5-ticket-watcher применяется для отладки либо обновления
билетов при нехватке сконфигурированного по умолчанию (сутки)
либо указанного администратором времени жизни таковых.

NB: не проверено на инсталяторах!
NOTE: не проверено на инсталяторах!
2 changes: 2 additions & 0 deletions features.in/dos/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/dos ===

Фича добавляет создание FreeDOS "live floppy" в stage1.

Текущее состояние -- загружается минимальная система.
Expand Down
2 changes: 2 additions & 0 deletions features.in/drm/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/drm ===

Фича drm решает задачу создания общей точки входа для
добавления drm-модулей ядра для разных списков пакетов.
Потребность выделения в отдельную фичу возникла с одной
Expand Down
2 changes: 2 additions & 0 deletions features.in/e2k/README
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
=== features.in/e2k ===

Эта фича содержит необходимое для поддержки систем архитектуры "Эльбрус".
9 changes: 7 additions & 2 deletions features.in/efi/README
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
=== features.in/efi ===

Фича добавляет в образы необходимое для поддержки EFI/UEFI.

Конфигурируется заданием загрузчика (EFI_BOOTLOADER)
и файла сертификата (EFI_CERT) при помощи целей;
пример использования доступен в conf.d/regular.mk

См. тж.:
* http://www.altlinux.org/UEFI
* http://www.rodsbooks.com/efi-bootloaders/

* https://www.altlinux.org/UEFI

* https://www.rodsbooks.com/efi-bootloaders/

* https://bugzilla.altlinux.org/showdependencytree.cgi?id=27804
2 changes: 2 additions & 0 deletions features.in/firmware/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/firmware ===

Эта фича добавляет комплекты различного firmware в инсталятор,
устанавливаемую систему и т.п.

Expand Down
2 changes: 2 additions & 0 deletions features.in/fonts/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/fonts ===

Эта фича позволяет системно конфигурировать файлы
конфигурации подсистемы конфигурирования шрифтов
fontconfig (sic!), заодно предоставляя прошедшие
Expand Down
6 changes: 5 additions & 1 deletion features.in/gitlab-runner/README
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
=== features.in/gitlab-runner ===

This feature installs gitlab-runner according official guide [1]

The following envs can be altered:
Expand All @@ -9,5 +11,7 @@ NOTE: this feature depends on network enablement in hasher (see [2] for details)
and mkimage [3]

1. https://docs.gitlab.com/runner/install/linux-manually.html

2. https://bugzilla.altlinux.org/34596
3. https://git.altlinux.org/people/legion/packages/mkimage.git?p=mkimage.git;a=commitdiff;h=6e90f032f15f89de1c2c523a725e369ab6cad1a0

3. https://git.altlinux.org/gears/m/mkimage.git?p=mkimage.git;a=commit;h=242549e3a01306e4539757e2129ea39f5a199b90
Loading

0 comments on commit 363ba22

Please sign in to comment.