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.51 2003/09/01 15:45:03 miles Exp $'
34 # Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2002, 2003
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) 2003 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
199 # duplicates of what's already in ChangeLog; it's the user's
200 # responsibility to remove them.
201 case $rlog_options in
203 if test -s "$changelog"
206 /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{
211 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
212 # old-fashioned date and time (Emacs 19.31 and earlier)
215 for (i=0; i<=11; i++) if (m[i] == $2) break
217 printf "%d-%02d-%02d\n", year, i+1, dd
221 d
=`$AWK "$e" <"$changelog"` ||
exit
223 ?
*) datearg
="-d>$d";;
228 # Use TZ specified by ChangeLog local variable, if any.
229 if test -s "$changelog"
232 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
235 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
239 logTZ
=`tail "$changelog" | sed -n "$extractTZ"`
241 ?
*) TZ
=$logTZ; export TZ
;;
245 # If CVS is in use, examine its repository, not the normal RCS files.
246 if test ! -f CVS
/Repository
252 repository
=`sed 1q <CVS/Repository` ||
exit
253 test ! -f CVS
/Root || CVSROOT
=`cat <CVS/Root` ||
exit
256 echo >&2 "$0: $CVSROOT: CVSROOT has multiple ':/'s"
260 pository
=`expr "X$repository" : '.*:\(/.*\)'`;;
265 *) repository
=${CVSROOT?}/$repository;;
267 if test ! -d "$repository"
269 echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
272 pository
=$repository;;
275 # Ensure that $pository ends in exactly one slash.
279 *//) pository
=`expr "X$pository" : 'X\(.*\)/'`;;
281 *) pository
=$pository/; break;;
285 # If no rlog options are given, and if we are in a tagged CVS branch,
286 # log only the changes in that branch.
287 case $rlog_options in
291 CVSTAG
=`cat <CVS/Tag` ||
exit
294 rlog_options
=-r`expr "$CVSTAG" : 'T\(.*\)'`;;
296 echo >&2 "$0: invalid CVS/Tag"; exit 1;;
302 # Use $rlog's -zLT option, if $rlog supports it.
303 case `$rlog -zLT 2>&1` in
306 case $rlog_options in
307 '') rlog_options
=-zLT;;
308 ?
*) rlog_options
=-zLT$nl$rlog_options;;
312 # With no arguments, examine all files under the RCS directory.
321 RCSdirs
=`find . -name RCS -type d -print`
322 filesFromRCSfiles
='s|,v$||; s|/RCS/|/|; s|^\./||'
331 ! -name .rcsfreeze.log \
332 ! -name .rcsfreeze.ver \
335 find . -name '*,v' -print
338 sed "$filesFromRCSfiles"
342 for file in RCS
/.
* RCS
/* .
*,v
*,v
345 RCS
/. | RCS
/.. | RCS
/,*, | RCS
/*_
) continue;;
346 RCS
/.rcsfreeze.log | RCS
/.rcsfreeze.ver
) continue;;
347 RCS
/.\
* | RCS
/\
* | .\
*,v | \
*,v
) test -f "$file" ||
continue;;
348 RCS
/*,v | RCS
/.
*,v
) ;;
349 RCS
/* | RCS
/.
*) test -f "$file" ||
continue;;
353 ?
*) files
=$files$nl$file;;
367 ?
*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogfile;;
368 '') $rlog $rlog_options ${1+"$@"} >$rlogfile;;
373 # Prefer the POSIX-style -k options, since POSIX 1003.1-2001 prohibits
374 # support for the traditional-style +M -N options.
375 SORT_K_OPTIONS
='-k 3,4r -k 5 -k 1'
376 sort $SORT_K_OPTIONS </dev
/null
2>/dev
/null || SORT_K_OPTIONS
='+2 -4r +4 +0'
379 # Get the full name of each author the logs mention, and set initialize_fullname
380 # to awk code that initializes the `fullname' awk associative array.
381 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
382 # you have to fix the resulting output by hand.
387 case $loginFullnameMailaddrs in
389 case $loginFullnameMailaddrs in
391 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
392 $loginFullnameMailaddrs
394 loginFullnameMailaddrs
=`cat $llogout`;;
399 for loginFullnameMailaddr
in $loginFullnameMailaddrs
402 set x
$loginFullnameMailaddr
406 initialize_fullname
="$initialize_fullname
407 fullname[\"$login\"] = \"$fullname\""
408 initialize_mailaddr
="$initialize_mailaddr
409 mailaddr[\"$login\"] = \"$mailaddr\""
416 sort -u -o $llogout <<EOF
422 esac >$llogout ||
exit
424 output_authors
='/^date: / {
425 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 ~ /^[^;]*;$/) {
426 print substr($5, 1, length($5)-1)
430 $AWK "$output_authors" <"$rlogfile" | sort -u | comm -23 - $llogout
434 cat >$llogout <<EOF || exit
437 initialize_author_script
='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
438 initialize_author
=`sed -e "$initialize_author_script" <$llogout`
441 alphabet = "abcdefghijklmnopqrstuvwxyz"
442 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
443 '"$initialize_author"'
448 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
449 # Remove the junk from fullnames like "0000-Admin(0000)".
450 fullname = substr(fullname, index(fullname, "-") + 1)
451 fullname = substr(fullname, 1, index(fullname, "(") - 1)
453 if (fullname ~ /,[^ ]/) {
454 # Some sites put comma-separated junk after the fullname.
455 # Remove it, but leave "Bill Gates, Jr" alone.
456 fullname = substr(fullname, 1, index(fullname, ",") - 1)
458 abbr = index(fullname, "&")
462 i = index(alphabet, a)
463 if (i) A = substr(ALPHABET, i, 1)
464 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
467 # Quote quotes and backslashes properly in full names.
468 # Do not use gsub; traditional awk lacks it.
472 p = index(rest, "\\")
473 q = index(rest, "\"")
480 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
481 rest = substr(rest, p+1)
484 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
490 initialize_fullname
=`
492 (getent passwd $authors) ||
495 for author in $authors
496 do NIS_PATH= nismatch $author passwd.org_dir
498 ypmatch $authors passwd
501 $AWK -F: "$awkscript"
502 `$initialize_fullname;;
506 # Function to print a single log line.
507 # We don't use awk functions, to stay compatible with old awk versions.
508 # `Log' is the log message.
509 # `files' contains the affected files.
512 # Following the GNU coding standards, rewrite
513 # * file: (function): comment
515 # * file (function): comment
516 if (Log ~ /^\([^)]*\):[\t\n ]/) {
518 filefunc = substr(Log, 1, i)
519 while ((j = index(filefunc, "\n"))) {
520 files = files " " substr(filefunc, 1, j-1)
521 filefunc = substr(filefunc, j+1)
523 files = files " " filefunc
524 Log = substr(Log, i+3)
527 # If "label: comment" is too long, break the line after the ":".
530 if ('"$length"' <= '"$indent"' + 1 + length(files) + i) sep = "\n" indent_string
533 printf "%s*%s:", indent_string, files
535 # Print each line of the log.
537 logline = substr(Log, 1, i-1)
538 if (logline ~ /[^'"$tab"' ]/) {
539 printf "%s%s\n", sep, logline
544 Log = substr(Log, i+1)
549 # Pattern to match the `revision' line of rlog output.
550 rlog_revision_pattern
='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'
555 hostname || uname -n || uuname -l || cat /etc/whoami
557 echo >&2 "$0: cannot deduce hostname"
564 domainname
=`(domainname) 2>/dev/null` &&
566 *.
*) hostname
=$hostname.
$domainname;;
572 # Process the rlog output, generating ChangeLog style entries.
574 # First, reformat the rlog output so that each line contains one log entry.
575 # Transliterate \n to SOH so that multiline entries fit on a single line.
576 # Discard irrelevant rlog output.
579 pository = "'"$pository"'"
583 if (pository != "") {
584 filename = substr($0, 11)
585 if (substr(filename, 1, length(pository)) == pository) {
586 filename = substr(filename, length(pository) + 1)
588 if (filename ~ /,v$/) {
589 filename = substr(filename, 1, length(filename) - 2)
591 if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
593 while (substr(filename, i, 1) != "/") i--
594 filename = substr(filename, 1, i - 6) substr(filename, i + 1)
599 /^Working file: / { if (repository == "") filename = substr($0, 15) }
600 /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
602 if (line ~ /'"$rlog_revision_pattern"'/) {
606 if (line ~ /^date: [0-9][- +\/0-9:]*;/) {
609 # This is a traditional RCS format date YYYY/MM/DD.
610 # Replace "/"s with "-"s to get ISO format.
612 while ((i = index(date, "/")) != 0) {
613 newdate = newdate substr(date, 1, i-1) "-"
614 date = substr(date, i+1)
618 time = substr($3, 1, length($3) - 1)
619 author = substr($5, 1, length($5)-1)
620 printf "%s%s%s%s%s%s%s%s%s%s", filename, SOH, rev, SOH, date, SOH, time, SOH, author, SOH
624 if (line ~ /^branches: /) { next }
625 if (line ~ /^(-----------*|===========*)$/) { print ""; next }
626 if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) {
629 printf "%s%s", line, SOH
633 # Now each line is of the form
634 # FILENAME@REVISION@YYYY-MM-DD@HH:MM:SS[+-TIMEZONE]@AUTHOR@LOG
635 # where @ stands for an SOH (octal code 001),
636 # and each line of LOG is terminated by SOH instead of \n.
637 # Sort the log entries, first by date+time (in reverse order),
638 # then by author, then by log entry, and finally by file name and revision
640 sort -t"$SOH" $SORT_K_OPTIONS |
642 # Finally, reformat the sorted log entries.
646 revision = "'"$revision"'"
648 # Initialize the fullname and mailaddr associative arrays.
649 '"$initialize_fullname"'
650 '"$initialize_mailaddr"'
652 # Initialize indent string.
655 if (0 < '"$tabwidth"')
656 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
657 indent_string = indent_string "\t"
659 indent_string = indent_string " "
664 for (i = 6; i < NF; i++) newlog = newlog $i "\n"
666 # Ignore log entries prefixed by "#".
667 if (newlog ~ /^#/) { next }
669 if (Log != newlog || date != $3 || author != $5) {
671 # The previous log and this log differ.
674 if (date != "") '"$printlogline"'
676 # Logs that begin with "{clumpname} " should be grouped together,
677 # and the clumpname should be removed.
678 # Extract the new clumpname from the log header,
679 # and use it to decide whether to output a blank line.
682 if (date == "") sep = ""
683 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
684 i = index(newlog, "}")
685 newclumpname = substr(newlog, 1, i)
686 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
687 newlog = substr(newlog, i+1)
688 if (clumpname == newclumpname && date == $3 && author == $5) sep = ""
691 clumpname = newclumpname
693 # Get ready for the next log.
696 for (i in filesknown)
700 if (date != $3 || author != $5) {
701 # The previous date+author and this date+author differ.
708 if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
709 zone = " " substr(time, i)
711 # Print "date[ timezone] fullname <email address>".
712 # Get fullname and email address from associative arrays;
713 # default to author and author@hostname if not in arrays.
714 if (fullname[author])
715 auth = fullname[author]
718 printf "%s%s %s ", date, zone, auth
719 if (mailaddr[author])
720 printf "<%s>\n\n", mailaddr[author]
722 printf "<%s@%s>\n\n", author, "'"$hostname"'"
724 if (! filesknown[$1]) {
726 if (files == "") files = " " $1
727 else files = files ", " $1
728 if (revision && $2 != "?") files = files " " $2
732 # Print the last log.
749 # arch-tag: cea067bd-a552-4254-ba17-078208933073