Docs: различия между версиями

Материал из ALT Linux Wiki
Нет описания правки
Нет описания правки
 
(не показано 5 промежуточных версий 2 участников)
Строка 1: Строка 1:
[[Category:Devel]]
{{span|font-size: 180%|}}
== Правила упаковки документации ==
{{Policy|since_branch=5.1|responsible=Игорь Власенко}}
== Полиси по упаковке документации ==


Упаковке подлежит вся документация, поставляемая с программой/библиотекой, за исключением  
Упаковке подлежит вся документация, поставляемая с программой/библиотекой, за исключением  
Строка 11: Строка 12:
Документация для разработчиков (описание API, примеры и т.д.) пакуется, в зависимости от размера
Документация для разработчиков (описание API, примеры и т.д.) пакуется, в зависимости от размера
* в -devel-пакет, если размер документации меньше остального содержимого пакета
* в -devel-пакет, если размер документации меньше остального содержимого пакета
* в -doc (или -devel-doc, если в -doc находится документация для пользователей), в противном случае
* в -doc (или -devel-doc, если в -doc находится документация для пользователей)


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

Текущая версия от 19:13, 21 ноября 2009

Stamp90cw.png
Действующая политика Sisyphus

Политика действует, начиная со стабильного бранча 5.1 и выше.

Ответственный за проведение политики в жизнь — Игорь Власенко.


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

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

  • стандартных файлов 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 килобайт, а также файлы, сжатием которых достигается значительный выигрыш в размере установленного пакета.