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.41 1997/05/13 22:44:08 eggert Exp eggert $'
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 case $loginFullnameMailaddrs in
94 '') loginFullnameMailaddrs
=$2$tab$3$tab$4;;
95 ?
*) loginFullnameMailaddrs
=$loginFullnameMailaddrs$nl$2$tab$3$tab$4
99 # If $2 is not tab-separated, use colon for separator.
102 echo >&2 "$0: -u '$2': newlines not allowed"
111 echo >&2 "$0: -u '$2': too many fields"
116 echo >&2 "$0: -u '$2': not enough fields"
119 case $loginFullnameMailaddrs in
120 '') loginFullnameMailaddrs
=$2;;
121 ?
*) loginFullnameMailaddrs
=$loginFullnameMailaddrs$nl$2
127 ?
*) logins
=$logins$nl$login
131 case $rlog_options in
132 '') rlog_options
=${2?};;
133 ?
*) rlog_options
=$rlog_options$nl${2?}
137 -t) tabwidth
=${2?}; shift;;
142 echo >&2 "rcs2log (GNU Emacs) $rcs2logVersion$nl$Copyright"
144 -*) echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help"
155 m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
156 m[3]="Apr"; m[4]="May"; m[5]="Jun"
157 m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
158 m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
162 # Put rlog output into $rlogout.
164 # If no rlog options are given,
165 # log the revisions checked in since the first ChangeLog entry.
166 # Since ChangeLog is only by date, some of these revisions may be duplicates of
167 # what's already in ChangeLog; it's the user's responsibility to remove them.
168 case $rlog_options in
170 if test -s "$changelog"
173 /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{
178 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
179 # old-fashioned date and time (Emacs 19.31 and earlier)
182 for (i=0; i<=11; i++) if (m[i] == $2) break
184 printf "%d-%02d-%02d\n", year, i+1, dd
188 d
=`$AWK "$e" <"$changelog"` ||
exit
195 # Use TZ specified by ChangeLog local variable, if any.
196 if test -s "$changelog"
199 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
202 /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
206 logTZ
=`tail "$changelog" | sed -n "$extractTZ"`
208 ?
*) TZ
=$logTZ; export TZ
212 # If CVS is in use, examine its repository, not the normal RCS files.
213 if test ! -f CVS
/Repository
219 repository
=`sed 1q <CVS/Repository` ||
exit
220 test ! -f CVS
/Root || CVSROOT
=`cat <CVS/Root` ||
exit
229 *) repository
=${CVSROOT?}/$repository
231 if test ! -d "$repository"
233 echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
239 # Use $rlog's -zLT option, if $rlog supports it.
240 case `$rlog -zLT 2>&1` in
243 case $rlog_options in
244 '') rlog_options
=-zLT;;
245 ?
*) rlog_options
=-zLT$nl$rlog_options
249 # With no arguments, examine all files under the RCS directory.
258 RCSdirs
=`find . -name RCS -type d -print`
259 filesFromRCSfiles
='s|,v$||; s|/RCS/|/|; s|^\./||'
268 ! -name .rcsfreeze.log \
269 ! -name .rcsfreeze.ver \
272 find . -name '*,v' -print
275 sed "$filesFromRCSfiles"
279 for file in RCS
/.
* RCS
/* .
*,v
*,v
282 RCS
/. | RCS
/.. | RCS
/,*, | RCS
/*_
) continue;;
283 RCS
/.rcsfreeze.log | RCS
/.rcsfreeze.ver
) continue;;
284 RCS
/.\
* | RCS
/\
* | .\
*,v | \
*,v
) test -f "$file" ||
continue;;
285 RCS
/*,v | RCS
/.
*,v
) ;;
286 RCS
/* | RCS
/.
*) test -f "$file" ||
continue
290 ?
*) files
=$files$nl$file
303 llogout
=$TMPDIR/rcs2log$
$l
304 rlogout
=$TMPDIR/rcs2log$
$r
306 trap "rm -f $llogout $rlogout; exit 1" 0
309 ?
*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogout;;
310 '') $rlog $rlog_options ${1+"$@"} >$rlogout
314 # Get the full name of each author the logs mention, and set initialize_fullname
315 # to awk code that initializes the `fullname' awk associative array.
316 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
317 # you have to fix the resulting output by hand.
322 case $loginFullnameMailaddrs in
324 case $loginFullnameMailaddrs in
326 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
327 $loginFullnameMailaddrs
329 loginFullnameMailaddrs
=`cat $llogout`
334 for loginFullnameMailaddr
in $loginFullnameMailaddrs
336 case $loginFullnameMailaddr in
340 set x
$loginFullnameMailaddr
344 initialize_fullname
="$initialize_fullname
345 fullname[\"$login\"] = \"$fullname\""
346 initialize_mailaddr
="$initialize_mailaddr
347 mailaddr[\"$login\"] = \"$mailaddr\""
353 ?
*) sort -u -o $llogout <<EOF || exit
357 output_authors
='/^date: / {
358 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 ~ /^[^;]*;$/) {
359 print substr($5, 1, length($5)-1)
363 $AWK "$output_authors" <$rlogout |
366 ?*) sort -u | comm -23 - $llogout
371 cat >$llogout <<EOF || exit
374 initialize_author_script
='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
375 initialize_author
=`sed -e "$initialize_author_script" <$llogout`
378 alphabet = "abcdefghijklmnopqrstuvwxyz"
379 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
380 '"$initialize_author"'
385 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
386 # Remove the junk from fullnames like "0000-Admin(0000)".
387 fullname = substr(fullname, index(fullname, "-") + 1)
388 fullname = substr(fullname, 1, index(fullname, "(") - 1)
390 if (fullname ~ /,[^ ]/) {
391 # Some sites put comma-separated junk after the fullname.
392 # Remove it, but leave "Bill Gates, Jr" alone.
393 fullname = substr(fullname, 1, index(fullname, ",") - 1)
395 abbr = index(fullname, "&")
399 i = index(alphabet, a)
400 if (i) A = substr(ALPHABET, i, 1)
401 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
404 # Quote quotes and backslashes properly in full names.
405 # Do not use gsub; traditional awk lacks it.
409 p = index(rest, "\\")
410 q = index(rest, "\"")
417 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
418 rest = substr(rest, p+1)
421 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
427 initialize_fullname
=`
430 for author in $authors
431 do NIS_PATH= nismatch $author passwd.org_dir
433 ypmatch $authors passwd
435 $AWK -F: "$awkscript"
436 `$initialize_fullname
440 # Function to print a single log line.
441 # We don't use awk functions, to stay compatible with old awk versions.
442 # `Log' is the log message (with \n replaced by \001).
443 # `files' contains the affected files.
446 # Following the GNU coding standards, rewrite
447 # * file: (function): comment
449 # * file (function): comment
450 if (Log ~ /^\([^)]*\): /) {
452 files = files " " substr(Log, 1, i)
453 Log = substr(Log, i+3)
456 # If "label: comment" is too long, break the line after the ":".
458 if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, SOH)) sep = "\n" indent_string
461 printf "%s*%s:", indent_string, files
463 # Print each line of the log, transliterating \001 to \n.
464 while ((i = index(Log, SOH)) != 0) {
465 logline = substr(Log, 1, i-1)
466 if (logline ~ /[^'"$tab"' ]/) {
467 printf "%s%s\n", sep, logline
472 Log = substr(Log, i+1)
476 # Pattern to match the `revision' line of rlog output.
477 rlog_revision_pattern
='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'
482 hostname || uname -n || uuname -l || cat /etc/whoami
484 echo >&2 "$0: cannot deduce hostname"
491 domainname
=`(domainname) 2>/dev/null` &&
493 *.
*) hostname
=$hostname.
$domainname
499 # Process the rlog output, generating ChangeLog style entries.
501 # First, reformat the rlog output so that each line contains one log entry.
502 # Transliterate \n to \001 so that multiline entries fit on a single line.
503 # Discard irrelevant rlog output.
505 BEGIN { repository = "'"$repository"'" }
507 if (repository != "") {
509 if (substr(filename, 1, length(repository) + 1) == repository "/") {
510 filename = substr(filename, length(repository) + 2)
512 if (filename ~ /,v$/) {
513 filename = substr(filename, 1, length(filename) - 2)
515 if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
517 while (substr(filename, i, 1) != "/") i--
518 filename = substr(filename, 1, i - 6) substr(filename, i + 1)
523 /^Working file:/ { if (repository == "") filename = $3 }
524 /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
526 if (line ~ /'"$rlog_revision_pattern"'/) {
530 if (line ~ /^date: [0-9][- +\/0-9:]*;/) {
533 # This is a traditional RCS format date YYYY/MM/DD.
534 # Replace "/"s with "-"s to get ISO format.
536 while ((i = index(date, "/")) != 0) {
537 newdate = newdate substr(date, 1, i-1) "-"
538 date = substr(date, i+1)
542 time = substr($3, 1, length($3) - 1)
543 author = substr($5, 1, length($5)-1)
544 printf "%s %s %s %s %s %c", filename, rev, date, time, author, 1
548 if (line ~ /^branches: /) { next }
549 if (line ~ /^(-----------*|===========*)$/) { print ""; next }
550 if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) {
553 printf "%s%c", line, 1
557 # Now each line is of the form
558 # FILENAME REVISION YYYY-MM-DD HH:MM:SS[+-TIMEZONE] AUTHOR \001LOG
559 # where \001 stands for a carriage return,
560 # and each line of the log is terminated by \001 instead of \n.
561 # Sort the log entries, first by date+time (in reverse order),
562 # then by author, then by log entry, and finally by file name and revision
566 # Finally, reformat the sorted log entries.
570 revision = "'"$revision"'"
572 # Some awk variants do not understand "\001", so we have to
573 # put the char directly in the file.
574 SOH="\x01" # <-- There is a single SOH (octal code 001) here.
576 # Initialize the fullname and mailaddr associative arrays.
577 '"$initialize_fullname"'
578 '"$initialize_mailaddr"'
580 # Initialize indent string.
583 if (0 < '"$tabwidth"')
584 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
585 indent_string = indent_string "\t"
587 indent_string = indent_string " "
591 newlog = substr($0, 1 + index($0, SOH))
593 # Ignore log entries prefixed by "#".
594 if (newlog ~ /^#/) { next }
596 if (Log != newlog || date != $3 || author != $5) {
598 # The previous log and this log differ.
601 if (date != "") '"$printlogline"'
603 # Logs that begin with "{clumpname} " should be grouped together,
604 # and the clumpname should be removed.
605 # Extract the new clumpname from the log header,
606 # and use it to decide whether to output a blank line.
609 if (date == "") sep = ""
610 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
611 i = index(newlog, "}")
612 newclumpname = substr(newlog, 1, i)
613 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
614 newlog = substr(newlog, i+1)
615 if (clumpname == newclumpname) sep = ""
618 clumpname = newclumpname
620 # Get ready for the next log.
623 for (i in filesknown)
627 if (date != $3 || author != $5) {
628 # The previous date+author and this date+author differ.
635 if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
636 zone = " " substr(time, i)
638 # Print "date[ timezone] fullname <email address>".
639 # Get fullname and email address from associative arrays;
640 # default to author and author@hostname if not in arrays.
641 if (fullname[author])
642 auth = fullname[author]
645 printf "%s%s %s ", date, zone, auth
646 if (mailaddr[author])
647 printf "<%s>\n\n", mailaddr[author]
649 printf "<%s@%s>\n\n", author, "'"$hostname"'"
651 if (! filesknown[$1]) {
653 if (files == "") files = " " $1
654 else files = files ", " $1
655 if (revision && $2 != "?") files = files " " $2
659 # Print the last log.
670 exec rm -f $llogout $rlogout