Package logilab :: Package common :: Module changelog
[frames] | no frames]

Module changelog

source code

Manipulation of upstream change log files.

The upstream change log files format handled is simpler than the one
often used such as those generated by the default Emacs changelog mode.

Sample ChangeLog format::

  Change log for project Yoo
  ==========================

   --
      * add a new functionality

  2002-02-01 -- 0.1.1
      * fix bug #435454
      * fix bug #434356

  2002-01-01 -- 0.1
      * initial release


There is 3 entries in this change log, one for each released version and one
for the next version (i.e. the current entry).
Each entry contains a set of messages corresponding to changes done in this
release.
All the non empty lines before the first entry are considered as the change
log title.

:copyright: 2003-2008 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
:license: General Public License version 2 - http://www.gnu.org/licenses

Classes
  ChangeLog
object representation of a whole ChangeLog file
  ChangeLogEntry
a change log entry, i.e.
  EntryNotFound
raised when we are unable to find a given entry
  NoEntry
raised when we are unable to find an entry
  Version
simple class to handle soft version number has a tuple while...
Variables
  BULLET = '*'
  INDENT = ' '
  SUBBULLET = '-'
  S_IWRITE = 128
  __package__ = 'logilab.common'