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 -R If no FILEs are given and RCS is used, recurse through working directory.
22 -r OPTION Pass OPTION to subsidiary log command.
23 -t TABWIDTH Tab stops are every TABWIDTH characters (default 8).
24 -u "LOGIN<tab>FULLNAME<tab>MAILADDR" Assume LOGIN has FULLNAME and MAILADDR.
25 -v Append RCS revision to file names in log lines.
27 --version Output version number.
29 Report bugs to <bug-gnu-emacs@prep.ai.mit.edu>.'
31 Id='$Id: rcs2log,v 1.37 1997/03/21 22:19:30 eggert Exp $'
33 # Copyright 1992, 1993, 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
35 # This program is free software; you can redistribute it and/or modify
36 # it under the terms of the GNU General Public License as published by
37 # the Free Software Foundation; either version 2, or (at your option)
40 # This program is distributed in the hope that it will be useful,
41 # but WITHOUT ANY WARRANTY; without even the implied warranty of
42 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43 # GNU General Public License for more details.
45 # You should have received a copy of the GNU General Public License
46 # along with this program; see the file COPYING. If not, write to the
47 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
48 # Boston, MA 02111-1307, USA.
50 Copyright='Copyright 1997 Free Software Foundation, Inc.
51 This program comes with NO WARRANTY, to the extent permitted by law.
52 You may redistribute copies of this program
53 under the terms of the GNU General Public License.
54 For more information about these matters, see the files named COPYING.
55 Author: Paul Eggert <eggert@twinsun.com>'
66 changelog=ChangeLog # change log file name
67 datearg= # rlog date option
68 hostname= # name of local host (if empty, will deduce it later)
69 indent=8 # indent of log line
70 length=79 # suggested max width of log line
71 logins= # login names for people we know fullnames and mailaddrs of
72 loginFullnameMailaddrs= # login<tab>fullname<tab>mailaddr triplets
73 logTZ= # time zone for log dates (if empty, use local time)
74 recursive= # t if we want recursive rlog
75 revision= # t if we want revision numbers
76 rlog_options= # options to pass to rlog
77 tabwidth=8 # width of horizontal tab
82 -c) changelog=${2?}; shift;;
83 -i) indent=${2?}; shift;;
84 -h) hostname=${2?}; shift;;
85 -l) length=${2?}; shift;;
86 -[nu]) # -n is obsolescent; it is replaced by -u.
88 -n) case ${2?}${3?}${4?} in
90 echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed"
93 loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$2$tab$3$tab$4
96 # If $2 is not tab-separated, use colon for separator.
99 echo >&2 "$0: -u '$2': newlines not allowed"
108 echo >&2 "$0: -u '$2': too many fields"
113 echo >&2 "$0: -u '$2': not enough fields"
116 loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$2
119 logins=$logins$nl$login
121 -r) rlog_options=$rlog_options$nl${2?}; shift;;
123 -t) tabwidth=${2?}; shift;;
128 echo >&2 "rcs2log (GNU Emacs) $rcs2logVersion$nl$Copyright"
130 -*) echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help"
141 m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
142 m[3]="Apr"; m[4]="May"; m[5]="Jun"
143 m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
144 m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
148 # Put rlog output into $rlogout.
150 # If no rlog options are given,
151 # log the revisions checked in since the first ChangeLog entry.
152 # Since ChangeLog is only by date, some of these revisions may be duplicates of
153 # what's already in ChangeLog; it's the user's responsibility to remove them.
154 case $rlog_options in
156 if test -s "$changelog"
159 /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{
164 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
165 # old-fashioned date and time (Emacs 19.31 and earlier)
168 for (i=0; i<=11; i++) if (m[i] == $2) break
170 printf "%d-%02d-%02d\n", year, i+1, dd
174 d=`$AWK "$e" <"$changelog"` || exit
181 # Use TZ specified by ChangeLog local variable, if any.
182 if test -s "$changelog"
185 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
188 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
192 logTZ=`tail "$changelog" | sed -n "$extractTZ"`
194 ?*) TZ=$logTZ; export TZ
198 # If CVS is in use, examine its repository, not the normal RCS files.
199 if test ! -f CVS/Repository
205 repository=`sed 1q <CVS/Repository` || exit
206 test ! -f CVS/Root || CVSROOT=`cat <CVS/Root` || exit
215 *) repository=${CVSROOT?}/$repository
217 if test ! -d "$repository"
219 echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
225 # Use $rlog's -zLT option, if $rlog supports it.
226 case `$rlog -zLT 2>&1` in
228 *) rlog_options=-zLT$nl$rlog_options
231 # With no arguments, examine all files under the RCS directory.
240 RCSdirs=`find . -name RCS -type d -print`
241 filesFromRCSfiles='s|,v$||; s|/RCS/|/|; s|^\./||'
250 ! -name .rcsfreeze.log \
251 ! -name .rcsfreeze.ver \
254 find . -name '*,v' -print
257 sed "$filesFromRCSfiles"
261 for file in RCS/.* RCS/* .*,v *,v
264 RCS/. | RCS/.. | RCS/,*, | RCS/*_) continue;;
265 RCS/.rcsfreeze.log | RCS/.rcsfreeze.ver) continue;;
266 RCS/.\* | RCS/\* | .\*,v | \*,v) test -f "$file" || continue
280 llogout=$TMPDIR/rcs2log$$l
281 rlogout=$TMPDIR/rcs2log$$r
283 trap "rm -f $llogout $rlogout; exit 1" 0
286 ?*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogout;;
287 '') $rlog $rlog_options ${1+"$@"} >$rlogout
291 # Get the full name of each author the logs mention, and set initialize_fullname
292 # to awk code that initializes the `fullname' awk associative array.
293 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
294 # you have to fix the resulting output by hand.
299 case $loginFullnameMailaddrs in
301 case $loginFullnameMailaddrs in
303 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
304 $loginFullnameMailaddrs
306 loginFullnameMailaddrs=`cat $llogout`
311 for loginFullnameMailaddr in $loginFullnameMailaddrs
313 case $loginFullnameMailaddr in
317 set x $loginFullnameMailaddr
321 initialize_fullname="$initialize_fullname
322 fullname[\"$login\"] = \"$fullname\""
323 initialize_mailaddr="$initialize_mailaddr
324 mailaddr[\"$login\"] = \"$mailaddr\""
330 ?*) sort -u -o $llogout <<EOF || exit
334 output_authors='/^date: / {
335 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 ~ /^[^;]*;$/) {
336 print substr($5, 1, length($5)-1)
340 $AWK "$output_authors" <$rlogout |
343 ?*) sort -u | comm -23 - $llogout
348 cat >$llogout <<EOF || exit
351 initialize_author_script='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
352 initialize_author=`sed -e "$initialize_author_script" <$llogout`
355 alphabet = "abcdefghijklmnopqrstuvwxyz"
356 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
357 '"$initialize_author"'
362 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
363 # Remove the junk from fullnames like "0000-Admin(0000)".
364 fullname = substr(fullname, index(fullname, "-") + 1)
365 fullname = substr(fullname, 1, index(fullname, "(") - 1)
367 if (fullname ~ /,[^ ]/) {
368 # Some sites put comma-separated junk after the fullname.
369 # Remove it, but leave "Bill Gates, Jr" alone.
370 fullname = substr(fullname, 1, index(fullname, ",") - 1)
372 abbr = index(fullname, "&")
376 i = index(alphabet, a)
377 if (i) A = substr(ALPHABET, i, 1)
378 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
381 # Quote quotes and backslashes properly in full names.
382 # Do not use gsub; traditional awk lacks it.
386 p = index(rest, "\\")
387 q = index(rest, "\"")
394 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
395 rest = substr(rest, p+1)
398 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
404 initialize_fullname=`
407 for author in $authors
408 do nismatch $author passwd.org_dir
410 ypmatch $authors passwd
412 $AWK -F: "$awkscript"
413 `$initialize_fullname
417 # Function to print a single log line.
418 # We don't use awk functions, to stay compatible with old awk versions.
419 # `Log' is the log message (with \n replaced by \r).
420 # `files' contains the affected files.
423 # Following the GNU coding standards, rewrite
424 # * file: (function): comment
426 # * file (function): comment
427 if (Log ~ /^\([^)]*\): /) {
429 files = files " " substr(Log, 1, i)
430 Log = substr(Log, i+3)
433 # If "label: comment" is too long, break the line after the ":".
435 if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, CR)) sep = "\n" indent_string
438 printf "%s*%s:", indent_string, files
440 # Print each line of the log, transliterating \r to \n.
441 while ((i = index(Log, CR)) != 0) {
442 logline = substr(Log, 1, i-1)
443 if (logline ~ /[^'"$tab"' ]/) {
444 printf "%s%s\n", sep, logline
449 Log = substr(Log, i+1)
453 # Pattern to match the `revision' line of rlog output.
454 rlog_revision_pattern='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'
459 hostname || uname -n || uuname -l || cat /etc/whoami
461 echo >&2 "$0: cannot deduce hostname"
468 domainname=`(domainname) 2>/dev/null` &&
470 *.*) hostname=$hostname.$domainname
476 # Process the rlog output, generating ChangeLog style entries.
478 # First, reformat the rlog output so that each line contains one log entry.
479 # Transliterate \n to \r so that multiline entries fit on a single line.
480 # Discard irrelevant rlog output.
482 BEGIN { repository = "'"$repository"'" }
484 if (repository != "") {
486 if (substr(filename, 1, length(repository) + 1) == repository "/") {
487 filename = substr(filename, length(repository) + 2)
489 if (filename ~ /,v$/) {
490 filename = substr(filename, 1, length(filename) - 2)
492 if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
494 while (substr(filename, i, 1) != "/") i--
495 filename = substr(filename, 1, i - 6) substr(filename, i + 1)
500 /^Working file:/ { if (repository == "") filename = $3 }
501 /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
502 if ($0 ~ /'"$rlog_revision_pattern"'/) {
506 if ($0 ~ /^date: [0-9][- +\/0-9:]*;/) {
509 # This is a traditional RCS format date YYYY/MM/DD.
510 # Replace "/"s with "-"s to get ISO format.
512 while ((i = index(date, "/")) != 0) {
513 newdate = newdate substr(date, 1, i-1) "-"
514 date = substr(date, i+1)
518 time = substr($3, 1, length($3) - 1)
519 author = substr($5, 1, length($5)-1)
520 printf "%s %s %s %s %s %c", filename, rev, date, time, author, 13
524 if ($0 ~ /^branches: /) { next }
525 if ($0 ~ /^(-----------*|===========*)$/) { print ""; next }
526 if ($0 == "Initial revision" || $0 ~ /^file .+ was initially added on branch .+\.$/) {
529 printf "%s%c", $0, 13
533 # Now each line is of the form
534 # FILENAME REVISION YYYY-MM-DD HH:MM:SS[+-TIMEZONE] AUTHOR \rLOG
535 # where \r stands for a carriage return,
536 # and each line of the log is terminated by \r instead of \n.
537 # Sort the log entries, first by date+time (in reverse order),
538 # then by author, then by log entry, and finally by file name and revision
542 # Finally, reformat the sorted log entries.
546 revision = "'"$revision"'"
548 # Some awk variants do not understand "\r" or "\013", so we have to
549 # put a carriage return directly in the file.
550 CR="
\r" # <-- There is a single CR between the " chars here.
552 # Initialize the fullname and mailaddr associative arrays.
553 '"$initialize_fullname"'
554 '"$initialize_mailaddr"'
556 # Initialize indent string.
559 if (0 < '"$tabwidth"')
560 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
561 indent_string = indent_string "\t"
563 indent_string = indent_string " "
567 newlog = substr($0, 1 + index($0, CR))
569 # Ignore log entries prefixed by "#".
570 if (newlog ~ /^#/) { next }
572 if (Log != newlog || date != $3 || author != $5) {
574 # The previous log and this log differ.
577 if (date != "") '"$printlogline"'
579 # Logs that begin with "{clumpname} " should be grouped together,
580 # and the clumpname should be removed.
581 # Extract the new clumpname from the log header,
582 # and use it to decide whether to output a blank line.
585 if (date == "") sep = ""
586 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
587 i = index(newlog, "}")
588 newclumpname = substr(newlog, 1, i)
589 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
590 newlog = substr(newlog, i+1)
591 if (clumpname == newclumpname) sep = ""
594 clumpname = newclumpname
596 # Get ready for the next log.
599 for (i in filesknown)
603 if (date != $3 || author != $5) {
604 # The previous date+author and this date+author differ.
611 if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
612 zone = " " substr(time, i)
614 # Print "date[ timezone] fullname <email address>".
615 # Get fullname and email address from associative arrays;
616 # default to author and author@hostname if not in arrays.
617 if (fullname[author])
618 auth = fullname[author]
621 printf "%s%s %s ", date, zone, auth
622 if (mailaddr[author])
623 printf "<%s>\n\n", mailaddr[author]
625 printf "<%s@%s>\n\n", author, "'"$hostname"'"
627 if (! filesknown[$1]) {
629 if (files == "") files = " " $1
630 else files = files ", " $1
631 if (revision && $2 != "?") files = files " " $2
635 # Print the last log.
646 exec rm -f $llogout $rlogout