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

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

Коллеги, в правильном составлении 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

@@ Строка 1: / Строка 1: @@
-[[Category:Devel]]
-{{MovedFromFreesourceInfo|AltLinux/Sisyphus/devel/spectips/ChangeLog}}
-== %changelog ==
-Формировать его удобнее (и надёжнее!) при помощи [[spectips/addchangelog|add_changelog]] (существуют также макросы для vim и *emacs).
   Коллеги, в правильном составлении changelog'ов среди вас замечено лишь несколько человек.
   Зачастую из-за неинформативного changelog'а другие разработчики теряют драгоценное время.
@@ Строка 12: / Строка 5: @@
   ldv
-Пример хороших записей (структурировать лучше именно так):
+Пример хорошей записи:
-<pre>* Sat Jul 02 2005 Sergey Vlasov <vsu@altlinux> 2.6.12-alt1
+<pre>
+* 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,
@@ Строка 53: / Строка 47: @@
    + fix compilation with 2.6.12
 - Updated kernel-feat-drivers-video-splash:
-   + updated splash patch for kernel 2.6.12</pre>
+   + updated splash patch for kernel 2.6.12
+</pre>