3 # RCS to ChangeLog generator
5 # Generate a change log prefix from RCS files (perhaps in the CVS repository)
6 # and the ChangeLog (if any).
7 # Output the new prefix to standard output.
8 # You can edit this prefix by hand, and then prepend it to ChangeLog.
10 # Ignore log entries that start with `#'.
11 # Clump together log entries that start with `{topic} ',
12 # where `topic' contains neither white space nor `}'.
14 Help
='The default FILEs are the files registered under the working directory.
17 -c CHANGELOG Output a change log prefix to CHANGELOG (default ChangeLog).
18 -h HOSTNAME Use HOSTNAME in change log entries (default current host).
19 -i INDENT Indent change log lines by INDENT spaces (default 8).
20 -l LENGTH Try to limit log lines to LENGTH characters (default 79).
21 -L FILE Use rlog-format FILE for source of logs.
22 -R If no FILEs are given and RCS is used, recurse through working directory.
23 -r OPTION Pass OPTION to subsidiary log command.
24 -t TABWIDTH Tab stops are every TABWIDTH characters (default 8).
25 -u "LOGIN<tab>FULLNAME<tab>MAILADDR" Assume LOGIN has FULLNAME and MAILADDR.
26 -v Append RCS revision to file names in log lines.
28 --version Output version number.
30 Report bugs to <bug-gnu-emacs@gnu.org>.'
32 Id
='$Id: rcs2log,v 1.47 2001/07/20 09:05:26 gerd Exp eggert $'
34 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001
35 # Free Software Foundation, Inc.
37 # This program is free software; you can redistribute it and/or modify
38 # it under the terms of the GNU General Public License as published by
39 # the Free Software Foundation; either version 2, or (at your option)
42 # This program is distributed in the hope that it will be useful,
43 # but WITHOUT ANY WARRANTY; without even the implied warranty of
44 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45 # GNU General Public License for more details.
47 # You should have received a copy of the GNU General Public License
48 # along with this program; see the file COPYING. If not, write to the
49 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
50 # Boston, MA 02111-1307, USA.
52 Copyright
='Copyright 2001 Free Software Foundation, Inc.
53 This program comes with NO WARRANTY, to the extent permitted by law.
54 You may redistribute copies of this program
55 under the terms of the GNU General Public License.
56 For more information about these matters, see the files named COPYING.
57 Author: Paul Eggert <eggert@twinsun.com>'
59 # Use the traditional C locale.
68 export LANG LANGUAGE LC_ALL LC_COLLATE LC_CTYPE LC_MESSAGES LC_NUMERIC LC_TIME
70 # These variables each contain a single ASCII character.
71 # Unfortunately, there's no portable way of writing these characters
72 # in older Unix implementations, other than putting them directly into
74 SOH
='\x01' # SOH, octal code 001
84 changelog
=ChangeLog
# change log file name
85 datearg
= # rlog date option
86 hostname
= # name of local host (if empty, will deduce it later)
87 indent
=8 # indent of log line
88 length
=79 # suggested max width of log line
89 logins
= # login names for people we know fullnames and mailaddrs of
90 loginFullnameMailaddrs
= # login<tab>fullname<tab>mailaddr triplets
91 logTZ
= # time zone for log dates (if empty, use local time)
92 recursive
= # t if we want recursive rlog
93 revision
= # t if we want revision numbers
94 rlog_options
= # options to pass to rlog
95 rlogfile
= # log file to read from
96 tabwidth
=8 # width of horizontal tab
101 -c) changelog
=${2?}; shift;;
102 -i) indent
=${2?}; shift;;
103 -h) hostname
=${2?}; shift;;
104 -l) length
=${2?}; shift;;
105 -L) rlogfile
=${2?}; shift;;
106 -[nu
]) # -n is obsolescent; it is replaced by -u.
108 -n) case ${2?}${3?}${4?} in
110 echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed"
115 shift; shift; shift;;
117 # If $2 is not tab-separated, use colon for separator.
120 echo >&2 "$0: -u '$2': newlines not allowed"
129 echo >&2 "$0: -u '$2': too many fields"
132 uf
="[^$t]*$t" # An unselected field, followed by a separator.
133 sf
="\\([^$t]*\\)" # The selected field.
134 login
=`expr "X$2" : "X$sf"`
136 expr "X$2" : "$uf$sf"
138 expr "X$2" : "$uf$uf$sf"
141 echo >&2 "$0: -u '$2': not enough fields"
148 ?
*) logins
=$logins$nl$login;;
150 case $loginFullnameMailaddrs in
151 '') loginFullnameMailaddrs
=$lfm;;
152 ?
*) loginFullnameMailaddrs
=$loginFullnameMailaddrs$nl$lfm;;
155 case $rlog_options in
156 '') rlog_options
=${2?};;
157 ?
*) rlog_options
=$rlog_options$nl${2?};;
161 -t) tabwidth
=${2?}; shift;;
166 echo >&2 "rcs2log (GNU Emacs) $rcs2logVersion$nl$Copyright"
168 -*) echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help"
179 m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
180 m[3]="Apr"; m[4]="May"; m[5]="Jun"
181 m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
182 m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
185 logdir
=$TMPDIR/rcs2log$$
188 trap "rm -fr $logdir 2>/dev/null" 0
189 (umask 077 && exec mkdir
$logdir) ||
exit
191 # If no rlog-format log file is given, generate one into $rlogfile.
196 # If no rlog options are given,
197 # log the revisions checked in since the first ChangeLog entry.
198 # Since ChangeLog is only by date, some of these revisions may be duplicates of
199 # what's already in ChangeLog; it's the user's responsibility to remove them.
200 case $rlog_options in
202 if test -s "$changelog"
205 /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{
210 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
211 # old-fashioned date and time (Emacs 19.31 and earlier)
214 for (i=0; i<=11; i++) if (m[i] == $2) break
216 printf "%d-%02d-%02d\n", year, i+1, dd
220 d
=`$AWK "$e" <"$changelog"` ||
exit
222 ?
*) datearg
="-d>$d";;
227 # Use TZ specified by ChangeLog local variable, if any.
228 if test -s "$changelog"
231 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
234 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
238 logTZ
=`tail "$changelog" | sed -n "$extractTZ"`
240 ?
*) TZ
=$logTZ; export TZ
;;
244 # If CVS is in use, examine its repository, not the normal RCS files.
245 if test ! -f CVS
/Repository
251 repository
=`sed 1q <CVS/Repository` ||
exit
252 test ! -f CVS
/Root || CVSROOT
=`cat <CVS/Root` ||
exit
255 echo >&2 "$0: $CVSROOT: CVSROOT has multiple ':/'s"
259 pository
=`expr "X$repository" : '.*:\(/.*\)'`;;
264 *) repository
=${CVSROOT?}/$repository;;
266 if test ! -d "$repository"
268 echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
271 pository
=$repository;;
274 # Ensure that $pository ends in exactly one slash.
278 *//) pository
=`expr "X$pository" : 'X\(.*\)/'`;;
280 *) pository
=$pository/; break;;
286 # Use $rlog's -zLT option, if $rlog supports it.
287 case `$rlog -zLT 2>&1` in
290 case $rlog_options in
291 '') rlog_options
=-zLT;;
292 ?
*) rlog_options
=-zLT$nl$rlog_options;;
296 # With no arguments, examine all files under the RCS directory.
305 RCSdirs
=`find . -name RCS -type d -print`
306 filesFromRCSfiles
='s|,v$||; s|/RCS/|/|; s|^\./||'
315 ! -name .rcsfreeze.log \
316 ! -name .rcsfreeze.ver \
319 find . -name '*,v' -print
322 sed "$filesFromRCSfiles"
326 for file in RCS
/.
* RCS
/* .
*,v
*,v
329 RCS
/. | RCS
/.. | RCS
/,*, | RCS
/*_
) continue;;
330 RCS
/.rcsfreeze.log | RCS
/.rcsfreeze.ver
) continue;;
331 RCS
/.\
* | RCS
/\
* | .\
*,v | \
*,v
) test -f "$file" ||
continue;;
332 RCS
/*,v | RCS
/.
*,v
) ;;
333 RCS
/* | RCS
/.
*) test -f "$file" ||
continue;;
337 ?
*) files
=$files$nl$file;;
351 ?
*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogfile;;
352 '') $rlog $rlog_options ${1+"$@"} >$rlogfile;;
357 # Get the full name of each author the logs mention, and set initialize_fullname
358 # to awk code that initializes the `fullname' awk associative array.
359 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
360 # you have to fix the resulting output by hand.
365 case $loginFullnameMailaddrs in
367 case $loginFullnameMailaddrs in
369 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
370 $loginFullnameMailaddrs
372 loginFullnameMailaddrs
=`cat $llogout`;;
377 for loginFullnameMailaddr
in $loginFullnameMailaddrs
380 set x
$loginFullnameMailaddr
384 initialize_fullname
="$initialize_fullname
385 fullname[\"$login\"] = \"$fullname\""
386 initialize_mailaddr
="$initialize_mailaddr
387 mailaddr[\"$login\"] = \"$mailaddr\""
394 sort -u -o $llogout <<EOF
400 esac >$llogout ||
exit
402 output_authors
='/^date: / {
403 if ($2 ~ /^[0-9]*[-\/][0-9][0-9][-\/][0-9][0-9]$/ && $3 ~ /^[0-9][0-9]:[0-9][0-9]:[0-9][0-9][-+0-9:]*;$/ && $4 == "author:" && $5 ~ /^[^;]*;$/) {
404 print substr($5, 1, length($5)-1)
408 $AWK "$output_authors" <"$rlogfile" | sort -u | comm -23 - $llogout
412 cat >$llogout <<EOF || exit
415 initialize_author_script
='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
416 initialize_author
=`sed -e "$initialize_author_script" <$llogout`
419 alphabet = "abcdefghijklmnopqrstuvwxyz"
420 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
421 '"$initialize_author"'
426 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
427 # Remove the junk from fullnames like "0000-Admin(0000)".
428 fullname = substr(fullname, index(fullname, "-") + 1)
429 fullname = substr(fullname, 1, index(fullname, "(") - 1)
431 if (fullname ~ /,[^ ]/) {
432 # Some sites put comma-separated junk after the fullname.
433 # Remove it, but leave "Bill Gates, Jr" alone.
434 fullname = substr(fullname, 1, index(fullname, ",") - 1)
436 abbr = index(fullname, "&")
440 i = index(alphabet, a)
441 if (i) A = substr(ALPHABET, i, 1)
442 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
445 # Quote quotes and backslashes properly in full names.
446 # Do not use gsub; traditional awk lacks it.
450 p = index(rest, "\\")
451 q = index(rest, "\"")
458 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
459 rest = substr(rest, p+1)
462 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
468 initialize_fullname
=`
470 (getent passwd $authors) ||
473 for author in $authors
474 do NIS_PATH= nismatch $author passwd.org_dir
476 ypmatch $authors passwd
479 $AWK -F: "$awkscript"
480 `$initialize_fullname;;
484 # Function to print a single log line.
485 # We don't use awk functions, to stay compatible with old awk versions.
486 # `Log' is the log message.
487 # `files' contains the affected files.
490 # Following the GNU coding standards, rewrite
491 # * file: (function): comment
493 # * file (function): comment
494 if (Log ~ /^\([^)]*\): /) {
496 filefunc = substr(Log, 1, i)
497 while ((j = index(filefunc, "\n"))) {
498 files = files " " substr(filefunc, 1, j-1)
499 filefunc = substr(filefunc, j+1)
501 files = files " " filefunc
502 Log = substr(Log, i+3)
505 # If "label: comment" is too long, break the line after the ":".
508 if ('"$length"' <= '"$indent"' + 1 + length(files) + i) sep = "\n" indent_string
511 printf "%s*%s:", indent_string, files
513 # Print each line of the log.
515 logline = substr(Log, 1, i-1)
516 if (logline ~ /[^'"$tab"' ]/) {
517 printf "%s%s\n", sep, logline
522 Log = substr(Log, i+1)
527 # Pattern to match the `revision' line of rlog output.
528 rlog_revision_pattern
='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'
533 hostname || uname -n || uuname -l || cat /etc/whoami
535 echo >&2 "$0: cannot deduce hostname"
542 domainname
=`(domainname) 2>/dev/null` &&
544 *.
*) hostname
=$hostname.
$domainname;;
550 # Process the rlog output, generating ChangeLog style entries.
552 # First, reformat the rlog output so that each line contains one log entry.
553 # Transliterate \n to SOH so that multiline entries fit on a single line.
554 # Discard irrelevant rlog output.
557 pository = "'"$pository"'"
561 if (pository != "") {
562 filename = substr($0, 11)
563 if (substr(filename, 1, length(pository)) == pository) {
564 filename = substr(filename, length(pository) + 1)
566 if (filename ~ /,v$/) {
567 filename = substr(filename, 1, length(filename) - 2)
569 if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
571 while (substr(filename, i, 1) != "/") i--
572 filename = substr(filename, 1, i - 6) substr(filename, i + 1)
577 /^Working file: / { if (repository == "") filename = substr($0, 15) }
578 /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
580 if (line ~ /'"$rlog_revision_pattern"'/) {
584 if (line ~ /^date: [0-9][- +\/0-9:]*;/) {
587 # This is a traditional RCS format date YYYY/MM/DD.
588 # Replace "/"s with "-"s to get ISO format.
590 while ((i = index(date, "/")) != 0) {
591 newdate = newdate substr(date, 1, i-1) "-"
592 date = substr(date, i+1)
596 time = substr($3, 1, length($3) - 1)
597 author = substr($5, 1, length($5)-1)
598 printf "%s%s%s%s%s%s%s%s%s%s", filename, SOH, rev, SOH, date, SOH, time, SOH, author, SOH
602 if (line ~ /^branches: /) { next }
603 if (line ~ /^(-----------*|===========*)$/) { print ""; next }
604 if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) {
607 printf "%s%s", line, SOH
611 # Now each line is of the form
612 # FILENAME@REVISION@YYYY-MM-DD@HH:MM:SS[+-TIMEZONE]@AUTHOR@LOG
613 # where @ stands for an SOH (octal code 001),
614 # and each line of LOG is terminated by SOH instead of \n.
615 # Sort the log entries, first by date+time (in reverse order),
616 # then by author, then by log entry, and finally by file name and revision
618 sort -t"$SOH" +2 -4r +4 +0 |
620 # Finally, reformat the sorted log entries.
624 revision = "'"$revision"'"
626 # Initialize the fullname and mailaddr associative arrays.
627 '"$initialize_fullname"'
628 '"$initialize_mailaddr"'
630 # Initialize indent string.
633 if (0 < '"$tabwidth"')
634 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
635 indent_string = indent_string "\t"
637 indent_string = indent_string " "
642 for (i = 6; i < NF; i++) newlog = newlog $i "\n"
644 # Ignore log entries prefixed by "#".
645 if (newlog ~ /^#/) { next }
647 if (Log != newlog || date != $3 || author != $5) {
649 # The previous log and this log differ.
652 if (date != "") '"$printlogline"'
654 # Logs that begin with "{clumpname} " should be grouped together,
655 # and the clumpname should be removed.
656 # Extract the new clumpname from the log header,
657 # and use it to decide whether to output a blank line.
660 if (date == "") sep = ""
661 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
662 i = index(newlog, "}")
663 newclumpname = substr(newlog, 1, i)
664 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
665 newlog = substr(newlog, i+1)
666 if (clumpname == newclumpname) sep = ""
669 clumpname = newclumpname
671 # Get ready for the next log.
674 for (i in filesknown)
678 if (date != $3 || author != $5) {
679 # The previous date+author and this date+author differ.
686 if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
687 zone = " " substr(time, i)
689 # Print "date[ timezone] fullname <email address>".
690 # Get fullname and email address from associative arrays;
691 # default to author and author@hostname if not in arrays.
692 if (fullname[author])
693 auth = fullname[author]
696 printf "%s%s %s ", date, zone, auth
697 if (mailaddr[author])
698 printf "<%s>\n\n", mailaddr[author]
700 printf "<%s@%s>\n\n", author, "'"$hostname"'"
702 if (! filesknown[$1]) {
704 if (files == "") files = " " $1
705 else files = files ", " $1
706 if (revision && $2 != "?") files = files " " $2
710 # Print the last log.