 |
ActiveTcl User Guide
|
 |
|
[ Main table Of Contents | Tcllib Table Of Contents | Tcllib Index ]
doctools::cvs(n) 0.1 "Documentation tools"
doctools::cvs - Handle text in 'cvs log' format
package require Tcl 8.2
package require textutil
package require doctools::cvs ?0.1?
This package provides tcl commands which are able to process and
reformat text in the format as generated by the cvs log command.
The commands scanLog and toChangeLog are derived from code found on the Tcl'ers
Wiki (http://wiki.tcl.tk). See the
references at the end of the page.
- ::doctools::cvs::scanLog text evar cvar fvar
- The command takes the text and fills the
variables whose names were specified through evar, cvar, and fvar with information from the CVS log.
Existing information is preserved, allowing the caller to merge
data from multiple logs into one database.
- evar
- Expected to refer to a scalar variable. After the call it
contains a list of all the entries found in the log file. An entry
is identified through the combination of date and author, and can
be split over multiple physical entries, one per touched file.
Note that the entries are listed in the same order as they were
found in the text. This is not necessarily
sorted by date or author.
Each item in the list is a list containing two elements, the date
of the entry, and its author, in this order. The date is of the
form year/month/day
- cvar
- Expected to refer to an array variable. Keys into the array are
the date and author of log entries, in this order, separated by a
comma.
The value per key is a list of comments made for the entry.
- fvar
- Expected to refer to an array variable. Keys into the array are
the date, author of a log entry, and a comment for that entry, in
this order, separated by commas.
The value per key is a list of files the entry is touching.
- ::doctools::cvs::toChangeLog evar cvar fvar
- The three arguments are the same as the last three arguments of
::doctools::cvs::scanLog. This command however
expects them to be filled with information about one or more logs.
It takes this information and constructs a text in the format of a
ChangeLog as accepted by emacs . The constructed text is
returned as the result of the command.
http://wiki.tcl.tk/log2changelog
changelog , cvs , cvs
log , log
Copyright © 2003 Andreas Kupries
<andreas_kupries@users.sourceforge.net>