table of contents
other versions
other sections
doctools::cvs(3tcl) | Documentation tools | doctools::cvs(3tcl) |
NAME¶
doctools::cvs - Processing text in 'cvs log' formatSYNOPSIS¶
package require Tcl 8.2DESCRIPTION¶
This package provides Tcl commands for the processing and reformatting text in the format generated by the cvs log command. The commands ::doctools::cvs::scanLog and ::doctools::cvs::toChangeLog are derived from code found on the Tcl'ers Wiki [http://wiki.tcl.tk]. See the references at the end of the page.API¶
- ::doctools::cvs::scanLog text evar cvar fvar
- The command takes the text and parses it under the
assumption that it contains a CVS log as generated by cvs log. The
resulting information is stored in the variables whose names were
specified via evar, cvar, and fvar.
- varname evar (in)
- Has to refer to a scalar variable. After the call this
variable will contain 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.
- varname cvar (in)
- Has to refer to an array variable. Keys are strings
containing the date and author of log entries, in this order, separated by
a comma.
- varname fvar (in)
- Has to refer to an array variable. Keys are strings
containing date, author of a log entry, and a comment for that entry, in
this order, separated by commas.
- ::doctools::cvs::toChangeLog evar cvar fvar
- ] The three arguments for this command are the same as the last three arguments of the command ::doctools::cvs::scanLog. This command however expects them to be filled with information about one or more logs. It takes this information and converts it into a text in the format of a ChangeLog as accepted and generated by emacs. The constructed text is returned as the result of the command.
BUGS, IDEAS, FEEDBACK¶
This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category doctools of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883]. Please also report any ideas for enhancements you may have for either package and/or documentation.SEE ALSO¶
http://wiki.tcl.tk/log2changelogKEYWORDS¶
changelog, cvs, cvs log, emacs, logCATEGORY¶
Documentation toolsCOPYRIGHT¶
Copyright (c) 2003-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>
1 | doctools |