[docs] проблемы модульной документации

[Fr. Br. George]

On Sun, Jun 17, 2007 at 07:22:45PM +0300, Artem Zolochevskiy wrote:
> Проблемы возникает при желании иметь одновременно документацию на 3.0 и 4.0 
> (ну, к примеру, я использую Сизиф). Т.е. модифицируя alterator_x11.kirill для 
> 4.0 у меня автоматически "ломается" документация на 3.0
Ну так и 3.0 ведь давным давно не существует на этой машине.  Для чего
документация на 3.0? Посмотреть, как было написано раньше? Правильно
настроенный hasher решает все проблемы. В том числе и такие:
старая документация может _вообще не установиться_ в Сизиф -- формат
поменялся, или ещё что.

> Похожие параллели можно провести и между server и desktop. У них "разъехались" 
> инсталляторы и по факту install0.kirill описывает именно server-ный вариант. 
Как это "разъехались"? В каком репозитории какой лежит?

> Опять же если его модифицировать для desktop, то неясно, как иметь под рукой 
> одновременно документацию по server и desktop.

> Особых идей у меня нет, но принципиально видится вот что...
всё-таки мне кажется, что проще всего сделать несколько vz или
hasher-окружений для разных веток, и туда ставить актуальную для них
документацию.

> 1. Смириться с тем, что к примеру, в Сизифе невозможно иметь докуменацию на 
> тот или иной выпуск дистрибутива (в том же виде в котором она туда попала).
> Ну не искать же в архиве именно те версии что были тогда и ставить их 
> вручную... 
> Очевидно, что этот вариант работает при условии разделения репозиториев. 3.0 
> отдельно, 4.0 - отдельно, 5.0 - отдельно ;-)
Ну так так это и делается. Они и есть все отдельно.

> Получить документацию на конкретный дистрибутив из Сизифа в этом случае 
> _невозможно_.
А зачем? Эта документация _не будет_ описывать Сизифа. Ведь нельзя же из
Сизифа получить, допустим, Qt2 -- но это не волнует даже того, кому Qt2
нужен.

> Тогда нужно помнить, что все docs-issue-...  в Сизифе отбражают 
> документацию непонятно на что.
Угу, на Сизиф. Вернее, на соответствующий класс дистрибутива, если бы его
собрали из Сизфа прямо сейчас. И это правильно, между прочим. Повышент
вероятность, что обратная связь по ошибкам в документации будет
действенной.

> Потому как совсем непонятно какие версии 
> модулей, составляющих конкретный docs-issue- установлены.
Последние.

> 2. Продумать систему именований модулей/пакетов, чтоб они соответсвовали тем 
> дистрибутивам, к которым они писались, что позволит иметь паралельно 
> установленную документацию относящуюся к разным выпускам.
В чём бонус по сравнению с установкой в hasher? В чём недостаток --
понятно: необходимо иметь двойную нумерацию: одну -- в стиле пакетов,
отражающую развитие текста, то есть версионирование, вторую --
привязанную к именам и версиям дистрибутива, а под ними -- снова
какое-то версионирование. Вот это будет всем деревьям дерево. А зачем?

> Как я понимаю, документация стала модульной не так давно -- со времён 3.0 и 
> может ещё просто эти вопросы не устоялись.
> Давайте чем-то порешим, либо просто растолкуйте что к чему.
> С Кириллом я немного тему обсуждал, но всё-же, согласитесь, ситуация несколько 
> запутанная.
> 
> Кто что скажет?
Насколько я помню, версионирование исходника -- дело автора.
Версионирование _модуля_ можно оформить в стине backports, но, повторяю,
это внесёт больше путаницы, чем порядка.

Я пока вижу только один недостаток: ресурсный. Нужно иметь под боком все
ветка, докуменацию которых хочется смотреть. С другой стороны, вам пакет
с документацией скачивать всё надо, а на худой конец rpm2cpio никто не
отменял.

-- 
			George V. Kouryachy (aka Fr. Br. George)
			mailto:george at altlinux_org