[docs] ( )
Artem Zolochevskiy
artem.zolochevskiy gmail.com
30 13:11:56 MSK 2008
hi all
Хочется привести в порядок наши пакеты документации. ПРедлагаю провести
предваритьльную ревизию.
Пара слов о происходящем:
- в настоящее время в репозитории присутсвую пакеты ДВУХ видов:
+ c commiter_id (например docs-vsftpd-kirill)
+ без commiter_id (например docs-whatis_linux)
Необходимость наличия commiter_id долгое время была продиктована
ограничениями, имеющимися в rpm-build-docs, которые используется для сборки
пакетов документации.
Мной ведётся работа по избавлению от commiter_id, для чего был создан
rpm-build-docs-experimental, не имеющий ограничений rpm-build-docs. С одной
стороны избавление от commiter_id делают имена пакетов документации (и
каталого, куда она устанавлявается) более читабельными, с другой -- spec фалы
пакетов без commiter_id (с использованием rpm-build-docs-experimental)
отличаются максимальной простотой (см. примеры
в /usr/share/doc/rpm-build-docs-experimental-0.4/examples/).
- в настоящее время в репозитории присутствуют явно устаревшие модули/выпуски,
полезность наличия которых сомнительна (пример docs-issue-compact3.0) и надо
принять решение по таким пакетам. Я за то, чтоб вынести их из репозитория,
т.к. это соответсвует идее "выпусков" (смотри обсуждение в docs@) Т.е.
достаточно, чтоб устаревший выпуск был в том репозитории, который он
описывает (в данном случае 3.0). Наличие же его в Сизифе заставляет держать в
репозитории и все зависимости такого пакета. Если же обновлять текты пакетов
от которых зависит устаревший выпуск, то сам выпуск превращается в абсолютно
неинформативный и не соответсвующий действительности текст.
Ещё кандидаты на "вылет":
+ docs-alterator_XX-kirill
+ docs-installX-kirill
+ docs-issue-install
- в настоящее время в репозитории присутсвуют выпуски/модули с разными схемами
именования (даже вне зависимости от наличия commiter_id)
примеры:
+ docs-install-junior
+ docs-whatis_junor
Предлагается привести ВСЕ имена пакетов к общему виду.
+ Выпуск: docs-issue_дальше_что_угодно
+ Модуль: docs-дальше_что угодно
Это позволит визуально отделить docs/docs-issue от имени модуля/выпуска
- в настоящее время пакеты документации содержат файл docinfo, на основании
которого генерируется html c информацией о пакете. Предлагаю содержимое
данного файла свести в необходимому минимуму. Так как 90% полей,
присутсвующих в нёв все равно не используются и мало кем обновляются
Для начала хватит :-)
Прилагаю файл, в котором можно видеть пакеты документации на сегодняшний день.
Жирным (друг под другом) выделены пакеты кандидаты на переименование.
Например:
+ docs-vsftpd-kirill
+ docs-vaftpd
Пока такие пакеты сосуществуют в репозитории, и я преднамеренно не ставил
Provides/Obsoletes дабы избежать проблем с выпусками, базирующимися на старых
(с commiter_id) пакетах. Выпуски, которые я мог поменять самостоятельно, я
уже изменил на использование моделей без commiter_id
Пакеты в левой колонке (не жирные) надо либо переименовыввать и обновлять,
либо выносить из репозитория, если они более не актуальны.
Пакеты в правой колонке -- это уже пакеты без commiter_id, однако некоторые из
них всё ещё не следуют единой схеме именования модулей/выпусков (см. выше).
Все переименованный пакеты имеются у меня в git. При этом я импортировал ВСЮ
испторию пакета ДО переименования. Так, что потери истории нет.
Что хотелось бы сейчас:
- Начать РЕАЛЬНОЕ переименование (выставление Provides/Obsoletes), но для
этого надо решить проблему выпусков, базирующихся на старых модулях (либо
выносить такие выпуски из репозитория совсем, либо одновлять их).
--
Артём Золочевский
----------- -----------
Было удалено вложение не в текстовом формате...
Имя : docs.ods
Тип : application/vnd.oasis.opendocument.spreadsheet
Размер : 20771 байтов
Описание: отсутствует
Url : http://lists.altlinux.org/pipermail/docs/attachments/20080130/f0d34b24/attachment-0001.bin
docs