Docs

Материал из ALT Linux Wiki

Правила упаковки документации

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

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

Документация для разработчиков (описание API, примеры и т.д.) пакуется, в зависимости от размера

  • в -devel-пакет, если размер документации меньше остального содержимого пакета
  • в -doc (или -devel-doc, если в -doc находится документация для пользователей), в противном случае

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