[docs] Re: webcvs

Anton V. Boyarshinov boyarsh на ru.echo.fr
Ср Июн 2 17:08:07 MSD 2004


On Wed, 2 Jun 2004 15:56:22 +0400 Kirill Maslinsky
 wrote:

> > > Совершенно согласен, не техническая. Собственно, и
> > > возможности cvs по управлению ветками и пр. не требуются и
> > > не должны использоваться в документации.
> > 
> > А, собственно, почему? Рассмотрим такие простые примеры:
> > 
> > 1) Есть некий большой текст и его надо серьёзно переработать.
> > При неиспользовании веток мы либо верменно "ломаем"
> > документацию либо лишаем автора естественного способа
> > взаимодействия с редактором(человеком, а не программой),
> > критиками, да и собсвтвенно возможности откатиться на некое
> > промежуточное состояние.
> 
> Хм, это надо обдумать. Однако вышеописанная ситуация мне всё же
> кажется немного натянутой: 
> 1) реальная "работающая" документация 
> содержится в пакетах, а не в cvs, поэтому "ломая" текст в cvs
> мы никак его не портим в дистрибутиве. А cvs и нужен для
> разработки. 

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

> 3) почему изменения, вносимые в текст лишают автора способа
> взаимодействия с редактором я, признаться, просто не понял. 

Ну, допустим, пишу (перерабатываю) я текст. Он ещё не закончен,
но с редактором и критиками поговорить уже есть о чём. Мне не
надо персонально рассылать неоконченные версии и вносить
редакторские правки руками, я просто объявляю что пишу его в
такой-то ветке. И редактор уже может работать над ним при том что
предидущая версия текста преспокойно живёт в основной ветке и в
любой момент может быть использована.
 
> > 2) Грамотное использование веток позволяет одноверменно вести
> > доработку доукументации выпущенных продуктов (например,
> > исправить ошибки/дополнить текст для дополнительного тиража)
> > и вести разработку вперёд.
> Не считаю, что доработка и разработка вперёд в случае
> документации -- это разные задачи. Отнюдь. Сейчас значительная
> часть документации -- общие разделы, которые применимы к любому
> дистрибутиву практически. Любые исправления и дополнения в них
> -- на пользу и уже выпущенному продукту и будущим. Если с
> изменением версий программ изменяется синтаксис и т. п. это
> опять же решается профилированием на уровне абзацев.

Честно говоря, я не уверен в том что тотально профилирование
лучше версионирования.
 
Не то что бы так уж настаивал на использовании веток ;), но не
могу не заметить что они бывают полезны ;)

Антон
-- 
mailto:boyarsh на mail.ru
mailto:boyarsh на ru.echo.fr
 17:00:00  up 9 days,  2:55, 10 users,  load average: 0.00, 0.03,
0.05


Подробная информация о списке рассылки docs