Summary: | Better docs | ||
---|---|---|---|
Product: | Sisyphus | Reporter: | Mikhail Yakshin <greycat> |
Component: | ruby-doc | Assignee: | Alexander Bokovoy <ab> |
Status: | CLOSED FIXED | QA Contact: | qa-sisyphus |
Severity: | enhancement | ||
Priority: | P2 | CC: | abulava, cas, imz, led, majioa, mike, nbr, pav, rider, stalker |
Version: | unstable | ||
Hardware: | all | ||
OS: | Linux |
Description
Mikhail Yakshin
2003-09-26 05:21:24 MSD
1. Вынес, будет отдельный пакет ruby-doc-extra-0.1-alt1 со всей дополнительной документацией (Programming Ruby, доклады с конференций, etc) 2. Генерация при установке мне не очень нравится -- тянет за собой достаточно большой комплект ненужных в работе ruby-stdlibs программ (graphviz, по крайней мере). Сгенерированная документация получается где-то в районе 20Мб. Могу сделать дополнительный пакет, который будет содержать сгенерированную документацию и обновлять его периодически. Пакет не будет требовать ничего для своей установки. 1. Ок, а что же тогда останется в ruby-doc? Какие-то ридмишки от мелких модулей? 2. Не очень понятно, чем не нравится динамическая генерация. Пусть будет виртуальный пакет типа ruby-doc-reference. Сам пакет будет выходить новый с каждой новой версией ruby-stdlibs (собираться из того же спека, что и они). В пакете ничего не будет, зато будет скрипт, запускающийся каждый раз при обновлении (обновление ruby-stdlibs будет тянуть за собой безусловное обновление ruby-doc-reference, если таковой установлен, т.е. зависимость ruby-doc-reference требует равный по версии ruby-stdlibs). Пакет ruby-doc-reference может требовать все, чего ему захочется. Если пользователю не нужна документация - пожалуйста, не ставь - не будет ни документации, ни зависимостей. Если нужна - замечательно... И еще я не очень понимаю, при чем тут graphviz. По-моему для генерации документации достаточно rdoc, разве нет? 1. Да, внутренняя документация. 2. Динамическая генерация занимает время. На AthlonXP 1700+ это порядка 5 минут. Такое недопустимо при обновлении. rdoc может генерировать графы зависимостей между модулями и классами, это самое важное в его функциональности. Для этого используется graphviz (dot), получающиеся файлы суммарно имеют объем около 15Мб. $ 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 :-( (In reply to comment #4) > Нету ruby-doc-extra Есть ruby-doc-extra! :-) По второму пункту, как понимаю, контрвозражений нет? С тех пор все радикально поменялось, так что, видимо, баг уже малоактуален. |