Docs

Материал из ALT Linux Wiki
Версия от 19:03, 28 июля 2008; MichaelShigorin (обсуждение | вклад) (Import from freesource.info)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
Freesource-logo.png Blue Glass Arrow.svg MediaWiki logo.png
Эта страница была перемещена с freesource.info.
Эта страница наверняка требует чистки и улучшения — смело правьте разметку и ссылки.
Просьба по окончанию убрать этот шаблон со страницы.


Советы по упаковке документации

Упаковке подлежит вся документация, поставляемая с программой/библиотекой, за исключением отдельных случаев:

  • Стандартные файлы INSTALL (см. письмо lav@), содержащие строку "These are generic installation instructions.". Эти файлы создаются путем копирования /usr/share/automake-*/INSTALL в процессе работы automake.
  • Пустые файлы NEWS и т.д.
  • Файлы стандартных лицензий
  • Руководства по сборке/установке программы, содержащие тривиальные рекомендации про ./configure && make && make install

Девелоперская документация библиотек, нужная лишь для разработки использующих эти библиотеки программ (руководства по API, примеры и т.д.) пакуются либо в -devel, либо в отдельный пакет (см. ниже).

Если объем документации сравним (а то и резко больше) объема остальных файлов пакета (как правило это пакет lib*-devel, содержащий небольшой /usr/include и более тяжелый /usr/share/doc, например старый libalsa-devel, стоит задуматься о выделении /usr/share/doc (возможно, за исключением NEWS и т.д.) в отдельный пакет lib*-doc либо lib*-devel-doc (нужно определиться с политикой именования). Примеры использования библиотеки/модуля, если они достаточно тяжелые, стоит паковать в отдельный foo-examples.

Часто пакет содержит очень объемистый файл Changelog и/или (реже) NEWS. Такие файлы необходимо сжимать перед упаковкой. Сжатию подлежат файлы более 100 килобайт, а также файлы, сжатием которых достигается значительный выигрыш в размере бинарного либо установленного пакета.

Ссылки