<?xml version="1.0" encoding="UTF-8" ?>

<bugzilla version="5.2"
          urlbase="https://bugzilla.altlinux.org/"
          
          maintainer="jenya@basealt.ru"
>

    <bug>
          <bug_id>3047</bug_id>
          
          <creation_ts>2003-09-26 05:21:24 +0400</creation_ts>
          <short_desc>Better docs</short_desc>
          <delta_ts>2006-12-17 10:19:23 +0300</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>4</classification_id>
          <classification>Development</classification>
          <product>Sisyphus</product>
          <component>ruby-doc</component>
          <version>unstable</version>
          <rep_platform>all</rep_platform>
          <op_sys>Linux</op_sys>
          <bug_status>CLOSED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>P2</priority>
          <bug_severity>enhancement</bug_severity>
          <target_milestone>---</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Mikhail Yakshin">greycat</reporter>
          <assigned_to name="Alexander Bokovoy">ab</assigned_to>
          <cc>abulava</cc>
    
    <cc>admsasha</cc>
    
    <cc>cas</cc>
    
    <cc>majioa</cc>
    
    <cc>mike</cc>
    
    <cc>nbr</cc>
    
    <cc>pav</cc>
    
    <cc>rider</cc>
    
    <cc>thatman</cc>
          
          <qa_contact>qa-sisyphus</qa_contact>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>9776</commentid>
    <comment_count>0</comment_count>
    <who name="Mikhail Yakshin">greycat</who>
    <bug_when>2003-09-26 05:21:24 +0400</bug_when>
    <thetext>У меня есть два предложения:

1. Вынести книжку &quot;Programming Ruby&quot; в отдельный пакет. Rationale: она
достаточно большая, насколько я знаю, со времен 1.6, если не раньше, вообще
никак не менялась, уже порядком устарела, хотя и является одним из наиболее
полных источников информации по Ruby. Вынесение ее в пакет типа ruby-doc-book
сэкономило бы массу трафика при апгрейдах. Заодно можно не извращаться, а
проставить тогда версию пакета равной версии книжки.

2. Генерировать rdoc для всего того, что есть в ruby-stdlibs прямо в пакете и
хранить статически, либо после установки генерить его на месте по post-install,
чтобы всегда под рукой был удобный reference manual.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>9885</commentid>
    <comment_count>1</comment_count>
    <who name="Alexander Bokovoy">ab</who>
    <bug_when>2003-09-29 13:34:03 +0400</bug_when>
    <thetext>1. Вынес, будет отдельный пакет ruby-doc-extra-0.1-alt1 со всей дополнительной
документацией (Programming Ruby, доклады с конференций, etc)

2. Генерация при установке мне не очень нравится -- тянет за собой достаточно
большой комплект ненужных в работе ruby-stdlibs программ (graphviz, по крайней
мере). Сгенерированная документация получается где-то в районе 20Мб.

Могу сделать дополнительный пакет, который будет содержать сгенерированную
документацию и обновлять его периодически. Пакет не будет требовать ничего для
своей установки.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>9922</commentid>
    <comment_count>2</comment_count>
    <who name="Mikhail Yakshin">greycat</who>
    <bug_when>2003-09-30 16:40:24 +0400</bug_when>
    <thetext>1. Ок, а что же тогда останется в ruby-doc? Какие-то ридмишки от мелких модулей?

2. Не очень понятно, чем не нравится динамическая генерация. Пусть будет
виртуальный пакет типа ruby-doc-reference. Сам пакет будет выходить новый с
каждой новой версией ruby-stdlibs (собираться из того же спека, что и они). В
пакете ничего не будет, зато будет скрипт, запускающийся каждый раз при
обновлении (обновление ruby-stdlibs будет тянуть за собой безусловное обновление
ruby-doc-reference, если таковой установлен, т.е. зависимость ruby-doc-reference
требует равный по версии ruby-stdlibs). Пакет ruby-doc-reference может требовать
все, чего ему захочется. Если пользователю не нужна документация - пожалуйста,
не ставь - не будет ни документации, ни зависимостей. Если нужна - замечательно...

И еще я не очень понимаю, при чем тут graphviz. По-моему для генерации
документации достаточно rdoc, разве нет?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>9924</commentid>
    <comment_count>3</comment_count>
    <who name="Alexander Bokovoy">ab</who>
    <bug_when>2003-09-30 16:47:42 +0400</bug_when>
    <thetext>1. Да, внутренняя документация.

2. Динамическая генерация занимает время. На AthlonXP 1700+ это порядка 5 минут.
Такое недопустимо при обновлении.

rdoc может генерировать графы зависимостей между модулями и классами, это самое
важное в его функциональности. Для этого используется graphviz (dot),
получающиеся файлы суммарно имеют объем около 15Мб.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>12209</commentid>
    <comment_count>4</comment_count>
    <who name="Andrei Bulava">abulava</who>
    <bug_when>2004-03-09 19:56:01 +0300</bug_when>
    <thetext>$ apt-cache search ruby-doc
fxruby-doc - Документация по FXRuby
ruby-doc - Documentation for the powerful language Ruby

Нету ruby-doc-extra, пришлось качать Programming Ruby v0.4 с
pragmaticprogrammer.com :-(</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>43230</commentid>
    <comment_count>5</comment_count>
    <who name="Michael Shigorin">mike</who>
    <bug_when>2006-12-16 23:21:33 +0300</bug_when>
    <thetext>(In reply to comment #4)
&gt; Нету ruby-doc-extra
Есть ruby-doc-extra! :-)

По второму пункту, как понимаю, контрвозражений нет?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>43246</commentid>
    <comment_count>6</comment_count>
    <who name="Mikhail Yakshin">greycat</who>
    <bug_when>2006-12-17 10:19:23 +0300</bug_when>
    <thetext>С тех пор все радикально поменялось, так что, видимо, баг уже малоактуален.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>