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



______________________________________________________________________________

NNAAMMEE
       doctools::changelog - Processing text in Emacs ChangeLog format

SSYYNNOOPPSSIISS
       package require TTccll  88..22

       package require tteexxttuuttiill

       package require ddooccttoooollss::::cchhaannggeelloogg  ??11??

       ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann _t_e_x_t

       ::::ddooccttoooollss::::cchhaannggeelloogg::::ttooDDooccttoooollss _t_i_t_l_e _m_o_d_u_l_e _v_e_r_s_i_o_n _e_n_t_r_i_e_s

       ::::ddooccttoooollss::::cchhaannggeelloogg::::mmeerrggee _e_n_t_r_i_e_s...

_________________________________________________________________

DDEESSCCRRIIPPTTIIOONN
       This package provides Tcl commands for the processing and reformatting
       of text in the "_C_h_a_n_g_e_L_o_g" format generated by eemmaaccss.

AAPPII
       ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann _t_e_x_t
              The command takes the _t_e_x_t and parses it under the assumption
              that it contains a ChangeLog as generated by eemmaaccss. It returns a
              data structure describing the contents of this ChangeLog.

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



                  {
                {
                    date
                    author
                    {
                   {
                       {file ...}
                       commenttext
                   }
                   ...
                    }
                }
                {...}
                  }


       ::::ddooccttoooollss::::cchhaannggeelloogg::::ttooDDooccttoooollss _t_i_t_l_e _m_o_d_u_l_e _v_e_r_s_i_o_n _e_n_t_r_i_e_s
              This command converts the pre-parsed ChangeLog _e_n_t_r_i_e_s as
              generated by the command ::::ddooccttoooollss::::cchhaannggeelloogg::::ssccaann into a
              document in _d_o_c_t_o_o_l_s format and returns it as the result of the
              command.

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

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

BBUUGGSS,, IIDDEEAASS,, FFEEEEDDBBAACCKK
       This document, and the package it describes, will undoubtedly contain
       bugs and other problems.  Please report such in the category _d_o_c_t_o_o_l_s
       of the _T_c_l_l_i_b _S_F _T_r_a_c_k_e_r_s
       [http://sourceforge.net/tracker/?group_id=12883].  Please also report
       any ideas for enhancements you may have for either package and/or
       documentation.

KKEEYYWWOORRDDSS
       changelog, doctools, emacs

CCAATTEEGGOORRYY
       Documentation tools

CCOOPPYYRRIIGGHHTT
       Copyright (c) 2003-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>




doctools                               1                doctools::changelog(n)
