3 # Copyright (C) 1995-2005 The Free Software Foundation, Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2, or (at your option)
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # RCS to ChangeLog generator
17 # Generate a change log prefix from RCS files (perhaps in the CVS repository)
18 # and the ChangeLog (if any).
19 # Output the new prefix to standard output.
20 # You can edit this prefix by hand, and then prepend it to ChangeLog.
22 # Ignore log entries that start with `#'.
23 # Clump together log entries that start with `{topic} ',
24 # where `topic' contains neither white space nor `}'.
26 Help
='The default FILEs are the files registered under the working directory.
29 -c CHANGELOG Output a change log prefix to CHANGELOG (default ChangeLog).
30 -h HOSTNAME Use HOSTNAME in change log entries (default current host).
31 -i INDENT Indent change log lines by INDENT spaces (default 8).
32 -l LENGTH Try to limit log lines to LENGTH characters (default 79).
33 -L FILE Use rlog-format FILE for source of logs.
34 -R If no FILEs are given and RCS is used, recurse through working directory.
35 -r OPTION Pass OPTION to subsidiary log command.
36 -t TABWIDTH Tab stops are every TABWIDTH characters (default 8).
37 -u "LOGIN<tab>FULLNAME<tab>MAILADDR" Assume LOGIN has FULLNAME and MAILADDR.
38 -v Append RCS revision to file names in log lines.
40 --version Output version number.
42 Report bugs to <bug-gnu-emacs@gnu.org>.'
44 Id
='Id: rcs2log,v 1.48 2001/09/05 23:07:46 eggert Exp'
46 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2003
47 # Free Software Foundation, Inc.
49 # This program is free software; you can redistribute it and/or modify
50 # it under the terms of the GNU General Public License as published by
51 # the Free Software Foundation; either version 2, or (at your option)
54 # This program is distributed in the hope that it will be useful,
55 # but WITHOUT ANY WARRANTY; without even the implied warranty of
56 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
57 # GNU General Public License for more details.
59 # You should have received a copy of the GNU General Public License
60 # along with this program; see the file COPYING. If not, write to the
61 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
62 # Boston, MA 02111-1307, USA.
64 Copyright
='Copyright 1992-2003 Free Software Foundation, Inc.
65 This program comes with NO WARRANTY, to the extent permitted by law.
66 You may redistribute copies of this program
67 under the terms of the GNU General Public License.
68 For more information about these matters, see the files named COPYING.
69 Author: Paul Eggert <eggert@twinsun.com>'
74 # Use the traditional C locale.
83 export LANG LANGUAGE LC_ALL LC_COLLATE LC_CTYPE LC_MESSAGES LC_NUMERIC LC_TIME
85 # These variables each contain a single ASCII character.
86 # Unfortunately, there's no portable way of writing these characters
87 # in older Unix implementations, other than putting them directly into
89 SOH
='\x01' # SOH, octal code 001
97 : ${MKTEMP="@MKTEMP@"}
101 changelog
=ChangeLog
# change log file name
102 datearg
= # rlog date option
103 hostname
= # name of local host (if empty, will deduce it later)
104 indent
=8 # indent of log line
105 length
=79 # suggested max width of log line
106 logins
= # login names for people we know fullnames and mailaddrs of
107 loginFullnameMailaddrs
= # login<tab>fullname<tab>mailaddr triplets
108 logTZ
= # time zone for log dates (if empty, use local time)
109 recursive
= # t if we want recursive rlog
110 revision
= # t if we want revision numbers
111 rlog_options
= # options to pass to rlog
112 rlogfile
= # log file to read from
113 tabwidth
=8 # width of horizontal tab
118 -c) changelog
=${2?}; shift;;
119 -i) indent
=${2?}; shift;;
120 -h) hostname
=${2?}; shift;;
121 -l) length
=${2?}; shift;;
122 -L) rlogfile
=${2?}; shift;;
123 -[nu
]) # -n is obsolescent; it is replaced by -u.
125 -n) case ${2?}${3?}${4?} in
127 echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed"
132 shift; shift; shift;;
134 # If $2 is not tab-separated, use colon for separator.
137 echo >&2 "$0: -u '$2': newlines not allowed"
146 echo >&2 "$0: -u '$2': too many fields"
149 uf
="[^$t]*$t" # An unselected field, followed by a separator.
150 sf
="\\([^$t]*\\)" # The selected field.
151 login
=`expr "X$2" : "X$sf"`
153 expr "X$2" : "$uf$sf"
155 expr "X$2" : "$uf$uf$sf"
158 echo >&2 "$0: -u '$2': not enough fields"
165 ?
*) logins
=$logins$nl$login;;
167 case $loginFullnameMailaddrs in
168 '') loginFullnameMailaddrs
=$lfm;;
169 ?
*) loginFullnameMailaddrs
=$loginFullnameMailaddrs$nl$lfm;;
172 case $rlog_options in
173 '') rlog_options
=${2?};;
174 ?
*) rlog_options
=$rlog_options$nl${2?};;
178 -t) tabwidth
=${2?}; shift;;
183 echo >&2 "rcs2log (GNU Emacs) $rcs2logVersion$nl$Copyright"
185 -*) echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help"
196 m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
197 m[3]="Apr"; m[4]="May"; m[5]="Jun"
198 m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
199 m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
202 logdir
=`$MKTEMP -d $TMPDIR/rcs2log.XXXXXX`
203 test -n "$logdir" ||
exit
206 trap "rm -fr $logdir 2>/dev/null" 0
208 # If no rlog-format log file is given, generate one into $rlogfile.
213 # If no rlog options are given,
214 # log the revisions checked in since the first ChangeLog entry.
215 # Since ChangeLog is only by date, some of these revisions may be duplicates of
216 # what's already in ChangeLog; it's the user's responsibility to remove them.
217 case $rlog_options in
219 if test -s "$changelog"
222 /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{
227 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
228 # old-fashioned date and time (Emacs 19.31 and earlier)
231 for (i=0; i<=11; i++) if (m[i] == $2) break
233 printf "%d-%02d-%02d\n", year, i+1, dd
237 d
=`$AWK "$e" <"$changelog"` ||
exit
239 ?
*) datearg
="-d>$d";;
244 # Use TZ specified by ChangeLog local variable, if any.
245 if test -s "$changelog"
248 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
251 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
255 logTZ
=`tail "$changelog" | sed -n "$extractTZ"`
257 ?
*) TZ
=$logTZ; export TZ
;;
261 # If CVS is in use, examine its repository, not the normal RCS files.
262 if test ! -f CVS
/Repository
268 repository
=`sed 1q <CVS/Repository` ||
exit
269 test ! -f CVS
/Root || CVSROOT
=`cat <CVS/Root` ||
exit
272 echo >&2 "$0: $CVSROOT: CVSROOT has multiple ':/'s"
276 pository
=`expr "X$repository" : '.*:\(/.*\)'`;;
281 *) repository
=${CVSROOT?}/$repository;;
283 if test ! -d "$repository"
285 echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
288 pository
=$repository;;
291 # Ensure that $pository ends in exactly one slash.
295 *//) pository
=`expr "X$pository" : 'X\(.*\)/'`;;
297 *) pository
=$pository/; break;;
303 # Use $rlog's -zLT option, if $rlog supports it.
304 case `$rlog -zLT 2>&1` in
307 case $rlog_options in
308 '') rlog_options
=-zLT;;
309 ?
*) rlog_options
=-zLT$nl$rlog_options;;
313 # With no arguments, examine all files under the RCS directory.
322 RCSdirs
=`find . -name RCS -type d -print`
323 filesFromRCSfiles
='s|,v$||; s|/RCS/|/|; s|^\./||'
332 ! -name .rcsfreeze.log \
333 ! -name .rcsfreeze.ver \
336 find . -name '*,v' -print
339 sed "$filesFromRCSfiles"
343 for file in RCS
/.
* RCS
/* .
*,v
*,v
346 RCS
/. | RCS
/.. | RCS
/,*, | RCS
/*_
) continue;;
347 RCS
/.rcsfreeze.log | RCS
/.rcsfreeze.ver
) continue;;
348 RCS
/.\
* | RCS
/\
* | .\
*,v | \
*,v
) test -f "$file" ||
continue;;
349 RCS
/*,v | RCS
/.
*,v
) ;;
350 RCS
/* | RCS
/.
*) test -f "$file" ||
continue;;
354 ?
*) files
=$files$nl$file;;
368 ?
*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogfile;;
369 '') $rlog $rlog_options ${1+"$@"} >$rlogfile;;
374 # Get the full name of each author the logs mention, and set initialize_fullname
375 # to awk code that initializes the `fullname' awk associative array.
376 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
377 # you have to fix the resulting output by hand.
382 case $loginFullnameMailaddrs in
384 case $loginFullnameMailaddrs in
386 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
387 $loginFullnameMailaddrs
389 loginFullnameMailaddrs
=`cat $llogout`;;
394 for loginFullnameMailaddr
in $loginFullnameMailaddrs
397 set x
$loginFullnameMailaddr
401 initialize_fullname
="$initialize_fullname
402 fullname[\"$login\"] = \"$fullname\""
403 initialize_mailaddr
="$initialize_mailaddr
404 mailaddr[\"$login\"] = \"$mailaddr\""
411 sort -u -o $llogout <<EOF
417 esac >$llogout ||
exit
419 output_authors
='/^date: / {
420 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 ~ /^[^;]*;$/) {
421 print substr($5, 1, length($5)-1)
425 $AWK "$output_authors" <"$rlogfile" | sort -u | comm -23 - $llogout
429 cat >$llogout <<EOF || exit
432 initialize_author_script
='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
433 initialize_author
=`sed -e "$initialize_author_script" <$llogout`
436 alphabet = "abcdefghijklmnopqrstuvwxyz"
437 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
438 '"$initialize_author"'
443 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
444 # Remove the junk from fullnames like "0000-Admin(0000)".
445 fullname = substr(fullname, index(fullname, "-") + 1)
446 fullname = substr(fullname, 1, index(fullname, "(") - 1)
448 if (fullname ~ /,[^ ]/) {
449 # Some sites put comma-separated junk after the fullname.
450 # Remove it, but leave "Bill Gates, Jr" alone.
451 fullname = substr(fullname, 1, index(fullname, ",") - 1)
453 abbr = index(fullname, "&")
457 i = index(alphabet, a)
458 if (i) A = substr(ALPHABET, i, 1)
459 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
462 # Quote quotes and backslashes properly in full names.
463 # Do not use gsub; traditional awk lacks it.
467 p = index(rest, "\\")
468 q = index(rest, "\"")
475 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
476 rest = substr(rest, p+1)
479 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
485 initialize_fullname
=`
487 (getent passwd $authors) ||
490 for author in $authors
491 do NIS_PATH= nismatch $author passwd.org_dir
493 ypmatch $authors passwd
496 $AWK -F: "$awkscript"
497 `$initialize_fullname;;
501 # Function to print a single log line.
502 # We don't use awk functions, to stay compatible with old awk versions.
503 # `Log' is the log message.
504 # `files' contains the affected files.
507 # Following the GNU coding standards, rewrite
508 # * file: (function): comment
510 # * file (function): comment
511 if (Log ~ /^\([^)]*\): /) {
513 filefunc = substr(Log, 1, i)
514 while ((j = index(filefunc, "\n"))) {
515 files = files " " substr(filefunc, 1, j-1)
516 filefunc = substr(filefunc, j+1)
518 files = files " " filefunc
519 Log = substr(Log, i+3)
522 # If "label: comment" is too long, break the line after the ":".
525 if ('"$length"' <= '"$indent"' + 1 + length(files) + i) sep = "\n" indent_string
528 printf "%s*%s:", indent_string, files
530 # Print each line of the log.
532 logline = substr(Log, 1, i-1)
533 if (logline ~ /[^'"$tab"' ]/) {
534 printf "%s%s\n", sep, logline
539 Log = substr(Log, i+1)
544 # Pattern to match the `revision' line of rlog output.
545 rlog_revision_pattern
='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'
550 hostname || uname -n || uuname -l || cat /etc/whoami
552 echo >&2 "$0: cannot deduce hostname"
559 domainname
=`(domainname) 2>/dev/null` &&
561 *.
*) hostname
=$hostname.
$domainname;;
567 # Process the rlog output, generating ChangeLog style entries.
569 # First, reformat the rlog output so that each line contains one log entry.
570 # Transliterate \n to SOH so that multiline entries fit on a single line.
571 # Discard irrelevant rlog output.
574 pository = "'"$pository"'"
578 if (pository != "") {
579 filename = substr($0, 11)
580 if (substr(filename, 1, length(pository)) == pository) {
581 filename = substr(filename, length(pository) + 1)
583 if (filename ~ /,v$/) {
584 filename = substr(filename, 1, length(filename) - 2)
586 if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
588 while (substr(filename, i, 1) != "/") i--
589 filename = substr(filename, 1, i - 6) substr(filename, i + 1)
594 /^Working file: / { if (repository == "") filename = substr($0, 15) }
595 /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
597 if (line ~ /'"$rlog_revision_pattern"'/) {
601 if (line ~ /^date: [0-9][- +\/0-9:]*;/) {
604 # This is a traditional RCS format date YYYY/MM/DD.
605 # Replace "/"s with "-"s to get ISO format.
607 while ((i = index(date, "/")) != 0) {
608 newdate = newdate substr(date, 1, i-1) "-"
609 date = substr(date, i+1)
613 time = substr($3, 1, length($3) - 1)
614 author = substr($5, 1, length($5)-1)
615 printf "%s%s%s%s%s%s%s%s%s%s", filename, SOH, rev, SOH, date, SOH, time, SOH, author, SOH
619 if (line ~ /^branches: /) { next }
620 if (line ~ /^(-----------*|===========*)$/) { print ""; next }
621 if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) {
624 printf "%s%s", line, SOH
628 # Now each line is of the form
629 # FILENAME@REVISION@YYYY-MM-DD@HH:MM:SS[+-TIMEZONE]@AUTHOR@LOG
630 # where @ stands for an SOH (octal code 001),
631 # and each line of LOG is terminated by SOH instead of \n.
632 # Sort the log entries, first by date+time (in reverse order),
633 # then by author, then by log entry, and finally by file name and revision
635 sort -t"$SOH" +2 -4r +4 +0 |
637 # Finally, reformat the sorted log entries.
641 revision = "'"$revision"'"
643 # Initialize the fullname and mailaddr associative arrays.
644 '"$initialize_fullname"'
645 '"$initialize_mailaddr"'
647 # Initialize indent string.
650 if (0 < '"$tabwidth"')
651 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
652 indent_string = indent_string "\t"
654 indent_string = indent_string " "
659 for (i = 6; i < NF; i++) newlog = newlog $i "\n"
661 # Ignore log entries prefixed by "#".
662 if (newlog ~ /^#/) { next }
664 if (Log != newlog || date != $3 || author != $5) {
666 # The previous log and this log differ.
669 if (date != "") '"$printlogline"'
671 # Logs that begin with "{clumpname} " should be grouped together,
672 # and the clumpname should be removed.
673 # Extract the new clumpname from the log header,
674 # and use it to decide whether to output a blank line.
677 if (date == "") sep = ""
678 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
679 i = index(newlog, "}")
680 newclumpname = substr(newlog, 1, i)
681 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
682 newlog = substr(newlog, i+1)
683 if (clumpname == newclumpname) sep = ""
686 clumpname = newclumpname
688 # Get ready for the next log.
691 for (i in filesknown)
695 if (date != $3 || author != $5) {
696 # The previous date+author and this date+author differ.
703 if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
704 zone = " " substr(time, i)
706 # Print "date[ timezone] fullname <email address>".
707 # Get fullname and email address from associative arrays;
708 # default to author and author@hostname if not in arrays.
709 if (fullname[author])
710 auth = fullname[author]
713 printf "%s%s %s ", date, zone, auth
714 if (mailaddr[author])
715 printf "<%s>\n\n", mailaddr[author]
717 printf "<%s@%s>\n\n", author, "'"$hostname"'"
719 if (! filesknown[$1]) {
721 if (files == "") files = " " $1
722 else files = files ", " $1
723 if (revision && $2 != "?") files = files " " $2
727 # Print the last log.