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.50 2002/02/03 17:31:31 eggert Exp $'
34 # Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2002
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 (C) 2002 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='
\ 1' # 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 # Prefer the POSIX-style -k options, since POSIX 1003.1-2001 prohibits
358 # support for the traditional-style +M -N options.
359 SORT_K_OPTIONS='-k 3,4r -k 5 -k 1'
360 sort $SORT_K_OPTIONS </dev/null 2>/dev/null || SORT_K_OPTIONS='+2 -4r +4 +0'
363 # Get the full name of each author the logs mention, and set initialize_fullname
364 # to awk code that initializes the `fullname' awk associative array.
365 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
366 # you have to fix the resulting output by hand.
371 case $loginFullnameMailaddrs in
373 case $loginFullnameMailaddrs in
375 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
376 $loginFullnameMailaddrs
378 loginFullnameMailaddrs=`cat $llogout`;;
383 for loginFullnameMailaddr in $loginFullnameMailaddrs
386 set x $loginFullnameMailaddr
390 initialize_fullname="$initialize_fullname
391 fullname[\"$login\"] = \"$fullname\""
392 initialize_mailaddr="$initialize_mailaddr
393 mailaddr[\"$login\"] = \"$mailaddr\""
400 sort -u -o $llogout <<EOF
406 esac >$llogout || exit
408 output_authors='/^date: / {
409 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 ~ /^[^;]*;$/) {
410 print substr($5, 1, length($5)-1)
414 $AWK "$output_authors" <"$rlogfile" | sort -u | comm -23 - $llogout
418 cat >$llogout <<EOF || exit
421 initialize_author_script='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
422 initialize_author=`sed -e "$initialize_author_script" <$llogout`
425 alphabet = "abcdefghijklmnopqrstuvwxyz"
426 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
427 '"$initialize_author"'
432 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
433 # Remove the junk from fullnames like "0000-Admin(0000)".
434 fullname = substr(fullname, index(fullname, "-") + 1)
435 fullname = substr(fullname, 1, index(fullname, "(") - 1)
437 if (fullname ~ /,[^ ]/) {
438 # Some sites put comma-separated junk after the fullname.
439 # Remove it, but leave "Bill Gates, Jr" alone.
440 fullname = substr(fullname, 1, index(fullname, ",") - 1)
442 abbr = index(fullname, "&")
446 i = index(alphabet, a)
447 if (i) A = substr(ALPHABET, i, 1)
448 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
451 # Quote quotes and backslashes properly in full names.
452 # Do not use gsub; traditional awk lacks it.
456 p = index(rest, "\\")
457 q = index(rest, "\"")
464 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
465 rest = substr(rest, p+1)
468 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
474 initialize_fullname=`
476 (getent passwd $authors) ||
479 for author in $authors
480 do NIS_PATH= nismatch $author passwd.org_dir
482 ypmatch $authors passwd
485 $AWK -F: "$awkscript"
486 `$initialize_fullname;;
490 # Function to print a single log line.
491 # We don't use awk functions, to stay compatible with old awk versions.
492 # `Log' is the log message.
493 # `files' contains the affected files.
496 # Following the GNU coding standards, rewrite
497 # * file: (function): comment
499 # * file (function): comment
500 if (Log ~ /^\([^)]*\):[\t\n ]/) {
502 filefunc = substr(Log, 1, i)
503 while ((j = index(filefunc, "\n"))) {
504 files = files " " substr(filefunc, 1, j-1)
505 filefunc = substr(filefunc, j+1)
507 files = files " " filefunc
508 Log = substr(Log, i+3)
511 # If "label: comment" is too long, break the line after the ":".
514 if ('"$length"' <= '"$indent"' + 1 + length(files) + i) sep = "\n" indent_string
517 printf "%s*%s:", indent_string, files
519 # Print each line of the log.
521 logline = substr(Log, 1, i-1)
522 if (logline ~ /[^'"$tab"' ]/) {
523 printf "%s%s\n", sep, logline
528 Log = substr(Log, i+1)
533 # Pattern to match the `revision' line of rlog output.
534 rlog_revision_pattern='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'
539 hostname || uname -n || uuname -l || cat /etc/whoami
541 echo >&2 "$0: cannot deduce hostname"
548 domainname=`(domainname) 2>/dev/null` &&
550 *.*) hostname=$hostname.$domainname;;
556 # Process the rlog output, generating ChangeLog style entries.
558 # First, reformat the rlog output so that each line contains one log entry.
559 # Transliterate \n to SOH so that multiline entries fit on a single line.
560 # Discard irrelevant rlog output.
563 pository = "'"$pository"'"
567 if (pository != "") {
568 filename = substr($0, 11)
569 if (substr(filename, 1, length(pository)) == pository) {
570 filename = substr(filename, length(pository) + 1)
572 if (filename ~ /,v$/) {
573 filename = substr(filename, 1, length(filename) - 2)
575 if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
577 while (substr(filename, i, 1) != "/") i--
578 filename = substr(filename, 1, i - 6) substr(filename, i + 1)
583 /^Working file: / { if (repository == "") filename = substr($0, 15) }
584 /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
586 if (line ~ /'"$rlog_revision_pattern"'/) {
590 if (line ~ /^date: [0-9][- +\/0-9:]*;/) {
593 # This is a traditional RCS format date YYYY/MM/DD.
594 # Replace "/"s with "-"s to get ISO format.
596 while ((i = index(date, "/")) != 0) {
597 newdate = newdate substr(date, 1, i-1) "-"
598 date = substr(date, i+1)
602 time = substr($3, 1, length($3) - 1)
603 author = substr($5, 1, length($5)-1)
604 printf "%s%s%s%s%s%s%s%s%s%s", filename, SOH, rev, SOH, date, SOH, time, SOH, author, SOH
608 if (line ~ /^branches: /) { next }
609 if (line ~ /^(-----------*|===========*)$/) { print ""; next }
610 if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) {
613 printf "%s%s", line, SOH
617 # Now each line is of the form
618 # FILENAME@REVISION@YYYY-MM-DD@HH:MM:SS[+-TIMEZONE]@AUTHOR@LOG
619 # where @ stands for an SOH (octal code 001),
620 # and each line of LOG is terminated by SOH instead of \n.
621 # Sort the log entries, first by date+time (in reverse order),
622 # then by author, then by log entry, and finally by file name and revision
624 sort -t"$SOH" $SORT_K_OPTIONS |
626 # Finally, reformat the sorted log entries.
630 revision = "'"$revision"'"
632 # Initialize the fullname and mailaddr associative arrays.
633 '"$initialize_fullname"'
634 '"$initialize_mailaddr"'
636 # Initialize indent string.
639 if (0 < '"$tabwidth"')
640 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
641 indent_string = indent_string "\t"
643 indent_string = indent_string " "
648 for (i = 6; i < NF; i++) newlog = newlog $i "\n"
650 # Ignore log entries prefixed by "#".
651 if (newlog ~ /^#/) { next }
653 if (Log != newlog || date != $3 || author != $5) {
655 # The previous log and this log differ.
658 if (date != "") '"$printlogline"'
660 # Logs that begin with "{clumpname} " should be grouped together,
661 # and the clumpname should be removed.
662 # Extract the new clumpname from the log header,
663 # and use it to decide whether to output a blank line.
666 if (date == "") sep = ""
667 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
668 i = index(newlog, "}")
669 newclumpname = substr(newlog, 1, i)
670 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
671 newlog = substr(newlog, i+1)
672 if (clumpname == newclumpname && date == $3 && author == $5) sep = ""
675 clumpname = newclumpname
677 # Get ready for the next log.
680 for (i in filesknown)
684 if (date != $3 || author != $5) {
685 # The previous date+author and this date+author differ.
692 if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
693 zone = " " substr(time, i)
695 # Print "date[ timezone] fullname <email address>".
696 # Get fullname and email address from associative arrays;
697 # default to author and author@hostname if not in arrays.
698 if (fullname[author])
699 auth = fullname[author]
702 printf "%s%s %s ", date, zone, auth
703 if (mailaddr[author])
704 printf "<%s>\n\n", mailaddr[author]
706 printf "<%s@%s>\n\n", author, "'"$hostname"'"
708 if (! filesknown[$1]) {
710 if (files == "") files = " " $1
711 else files = files ", " $1
712 if (revision && $2 != "?") files = files " " $2
716 # Print the last log.