doctools::changelog(n) Documentation tools doctools::changelog(n)

NAME
       doctools::changelog - Handle text in Emacs ChangeLog format

SYNOPSIS
       package require TTccll  88..22

       package require tteexxttuuttiill

       package require ddooccttoooollss::::cchhaannggeelloogg  ??00..11??

       ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann text

       ::::ddooccttoooollss::::cchhaannggeelloogg::::ttooDDooccttoooollss title module version entries

       ::::ddooccttoooollss::::cchhaannggeelloogg::::mmeerrggee entries...



DESCRIPTION
       This package provides tcl commands which are able to process and refor-
       mat text in the "ChangeLog" format generated eemmaaccss.

CCOOMMMMAANNDDSS
       ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann text
              The command takes the text, parses it under the assumption  that
              it contains a ChangeLog as generated by eemmaaccss and returns a data
              structure describing this ChangeLog.

              This data structure is a list whose elements describe one  entry
              in  the  ChangeLog  each. Each entry is a list of three elements
              describing date of the entry, its author, and the comments made,
              in this order.  The last element of each entry, the comments, is
              a list of sections. Each section is described by two elements, a
              list  of  file  names,  and a string containing the true comment
              associated with the files of the section.

       ::::ddooccttoooollss::::cchhaannggeelloogg::::ttooDDooccttoooollss title module version entries
              This command converts the pre-parsed ChangeLog entries (as  gen-
              erated  by  ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann) into a document in doc-
              tools format and returns it as the result of the command.

              The other three arguments supply information for the  header  of
              that  document which is not available from the changelog itself.

       ::::ddooccttoooollss::::cchhaannggeelloogg::::mmeerrggee entries...
              Each argument of the command  is  assumed  to  be  a  pre-parsed
              Changelog as generated by ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann). The com-
              mand merges all of them into a single structure, collapsing mul-
              tiple  entries for the same date and author into a single entry.
              The new structure is returned as the result of the command.

KKEEYYWWOORRDDSS
       changelog, doctools, emacs

COPYRIGHT       Copyright (c) 2003 Andreas Kupries 



doctools                              0.1               doctools::changelog(n)