Руководство по написанию changelog/Пример: различия между версиями

Версия от 01:56, 4 августа 2008

Эта страница была перемещена с freesource.info.
Эта страница наверняка требует чистки и улучшения — смело правьте разметку и ссылки.
Просьба по окончанию убрать этот шаблон со страницы.

%changelog

Формировать его удобнее (и надёжнее!) при помощи add_changelog (существуют также макросы для vim и *emacs).

Коллеги, в правильном составлении changelog'ов среди вас замечено лишь несколько человек.
Зачастую из-за неинформативного changelog'а другие разработчики теряют драгоценное время.
Если не знаете, с кого брать пример, посмотрите на changelog'и, которые пишет Сергей Власов.
-- 
ldv

Пример хороших записей (структурировать лучше именно так):

* Sat Jul 02 2005 Sergey Vlasov <vsu@altlinux> 2.6.12-alt1
- 2.6.12.
- Updated kernel-fix-build, kernel-fix-core, kernel-fix-drivers-char,
  kernel-fix-drivers-ide, kernel-fix-drivers-media, kernel-fix-drivers-net,
  kernel-fix-drivers-pci, kernel-fix-drivers-scsi, kernel-fix-drivers-usb,
  kernel-fix-drivers-video, kernel-fix-fs, kernel-fix-net, kernel-fix-security:
  - removed obsolete patches
- Updated kernel-fix-acpi:
  + updated acpi-attrs and suspend-setup-leave patches for 2.6.12
  + call acpi_register_gsi() even for default PCI interrupt assignment (needed
    to set PCI interrupts to level/low properly)
- Updated kernel-fix-core:
  + round size in remap_pfn_range() up to a page boundary
  + add "memory" clobbers to string.h functions to avoid memory access
    reordering by gcc
- Updated kernel-fix-drivers-media:
  + updated Manli and BeholdTV remote control support patch for 2.6.12
- Updated kernel-fix-drivers-net:
  + e1000: fix spinlock bug
- Updated kernel-fix-drivers-pci:
  + fix typo in drv->driver.shutdown setting for PCI drivers that might result
    in not setting drv->driver.owner
- Updated kernel-fix-drivers-scsi:
  + fix qla2xxx initialization problems
- Updated kernel-fix-drivers-usb:
  + updated old_scheme_first patch for 2.6.12
- Updated kernel-fix-net:
  + fix connection tracking on bridges
  + fix socket hashing bugs in netlink
- Updated kernel-fix-security:
  + CAN-2005-1913
- Updated kernel-feat-drivers-input:
  + updated trackpoint support patch:
    - warning: module parameters for trackpoint device configuration are no
      longer available - use sysfs for configuration;
    - support for scroll emulation in the driver was removed - use the
      appropriate Xorg options
- Updated kernel-feat-drivers-lirc, kernel-feat-drivers-sk98lin:
  + fix compilation with 2.6.12
- Updated kernel-feat-drivers-video-splash:
  + updated splash patch for kernel 2.6.12

@@ Строка 6: / Строка 6: @@
 Формировать его удобнее (и надёжнее!) при помощи [[spectips/addchangelog|add_changelog]] (существуют также макросы для vim и *emacs).
-<pre>Коллеги, в правильном составлении changelog'ов среди вас замечено лишь несколько человек.
+ Коллеги, в правильном составлении changelog'ов среди вас замечено лишь несколько человек.
-Зачастую из-за неинформативного changelog'а другие разработчики теряют драгоценное время.
+ Зачастую из-за неинформативного changelog'а другие разработчики теряют драгоценное время.
-Если не знаете, с кого брать пример, посмотрите на changelog'и, которые пишет Сергей Власов.
+ Если не знаете, с кого брать пример, посмотрите на changelog'и, которые пишет Сергей Власов.
---
+ --
-ldv</pre>
+ ldv
 Пример хороших записей (структурировать лучше именно так):
@@ Строка 54: / Строка 54: @@
 - Updated kernel-feat-drivers-video-splash:
    + updated splash patch for kernel 2.6.12</pre>
-Если пакет содержит исправления по части безопасности, следует добавить идентификацию проблемы принятым образом (например, по [http://cve.mitre.org/ CVE]:
-<pre>* Tue Oct 11 2005 Dmitry V. Levin <ldv@altlinux.org> 0.9.7d-alt2
-- Applied upstream fix for potential SSL 2.0 rollback
-  during SSL handshake (CAN-2005-2969).</pre>
-Есть ещё [http://lists.altlinux.org/pipermail/devel/2006-October/037171.html такой нюанс] с использованием <tt>#...</tt>:
-<pre>> > QTR> ebtables - A filtering tool for a bridging firewall
-> > QTR> * Fri Oct 06 2006 Vladimir V Kamarzin <vvk@altlinux> 2.0.6-alt2
-> > QTR> - Added patch from Debian to make ebtables compile with gcc-4 (Debian bug
-> > QTR>   - Dropped unneeded ebtables-2.0.6-gcc34.patch
-> > QTR> * Fri Aug 12 2005 Victor Forsyuk <force@altlinux> 2.0.6-alt1
-> >     Номер бага в дебиане подразумевался но, видимо, пропал.
-> Похоже, строки вида /^[[:space:]]*#/ rpm считает комментариями даже в
-> секции %changelog (причём пробелы остаются).
-Именно так rpmbuild и делает, если посмотреть в parseChangelog(),
-то можно увидеть readLine(spec, STRIP_COMMENTS).
-Не знаю, может и зря он так делает.</pre>
-Если новая сборка содержит исправления, присланные кем-либо ещё (почтой, через bugzilla, ...) -- следует упомянуть это:
-<pre>Честно говоря, мне казалось очевидным, что принимающий патч должен считать
-своим долгом отразить это в changelog'е, а отправляющему патч не стоит
-публично упрекать принимающего в том, что он этот свой долг не выполнил.</pre>
-''[http://lists.altlinux.org/pipermail/devel/2007-March/043068.html ldv@]''
-Советы о том, как ''не'' рекомендуется оформлять %changelog, вы можете прочитать [[TypicalPackagingErrors/changelog|здесь]].