3 # RCS to ChangeLog generator
5 # Generate a change log prefix from RCS files and the ChangeLog (if any).
6 # Output the new prefix to standard output.
7 # You can edit this prefix by hand, and then prepend it to ChangeLog.
9 # Ignore log entries that start with `#'.
10 # Clump together log entries that start with `{topic} ',
11 # where `topic' contains neither white space nor `}'.
13 # Author: Paul Eggert <eggert@twinsun.com>
15 # $Id: rcs2log,v 1.22 1995/04/30 15:34:52 eggert Exp $
17 # Copyright 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
19 # This program is free software; you can redistribute it and/or modify
20 # it under the terms of the GNU General Public License as published by
21 # the Free Software Foundation; either version 2, or (at your option)
24 # This program is distributed in the hope that it will be useful,
25 # but WITHOUT ANY WARRANTY; without even the implied warranty of
26 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 # GNU General Public License for more details.
29 # You should have received a copy of the GNU General Public License
30 # along with this program; see the file COPYING. If not, write to
31 # the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
42 hostname
= # name of local host (if empty, will deduce it later)
43 indent
=8 # indent of log line
44 length
=79 # suggested max width of log line
45 logins
= # login names for people we know fullnames and mailaddrs of
46 loginFullnameMailaddrs
= # login<tab>fullname<tab>mailaddr triplets
47 recursive
= # t if we want recursive rlog
48 rlog_options
= # options to pass to rlog
49 tabwidth
=8 # width of horizontal tab
54 -i) indent
=${2?}; shift;;
55 -h) hostname
=${2?}; shift;;
56 -l) length
=${2?}; shift;;
57 -[nu
]) # -n is obsolescent; it is replaced by -u.
59 -n) case ${2?}${3?}${4?} in
61 echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed"
64 loginFullnameMailaddrs
=$loginFullnameMailaddrs$nl$2$tab$3$tab$4
67 # If $2 is not tab-separated, use colon for separator.
70 echo >&2 "$0: -u '$2': newlines not allowed"
79 echo >&2 "$0: -u '$2': too many fields"
84 echo >&2 "$0: -u '$2': not enough fields"
87 loginFullnameMailaddrs
=$loginFullnameMailaddrs$nl$2
90 logins
=$logins$nl$login
92 -r) rlog_options
=$rlog_options$nl${2?}; shift;;
94 -t) tabwidth
=${2?}; shift;;
95 -*) echo >&2 "$0: usage: $0 [options] [file ...]
97 [-h hostname] [-i indent] [-l length] [-R] [-r rlog_option]
98 [-t tabwidth] [-u 'login<TAB>fullname<TAB>mailaddr']..."
106 m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
107 m[3]="Apr"; m[4]="May"; m[5]="Jun"
108 m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
109 m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
111 # days in non-leap year thus far, indexed by month (0-12)
112 mo[0]=0; mo[1]=31; mo[2]=59; mo[3]=90
113 mo[4]=120; mo[5]=151; mo[6]=181; mo[7]=212
114 mo[8]=243; mo[9]=273; mo[10]=304; mo[11]=334
119 # Put rlog output into $rlogout.
121 # If no rlog options are given,
122 # log the revisions checked in since the first ChangeLog entry.
123 case $rlog_options in
128 # Add 1 to seconds to avoid duplicating most recent log.
130 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
133 for (i=0; i<=11; i++) if (m[i] == $2) break
148 monthdays = mo[i+1] - mo[i]
149 if (i == 1 && year%4 == 0 && (year%100 != 0 || year%400 == 0)) monthdays++
150 if (dd == monthdays + 1) {
161 printf "%d/%02d/%02d %02d:%02d:%02d\n", year,i+1,dd,hh,mm,ss
165 d
=`$AWK "$e" <ChangeLog` ||
exit
173 # If CVS is in use, examine its repository, not the normal RCS files.
174 if test ! -f CVS
/Repository
180 repository
=`sed 1q <CVS/Repository` ||
exit
183 *) repository
=${CVSROOT?}/$repository
185 if test ! -d "$repository"
187 echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
192 # With no arguments, examine all files under the RCS directory.
201 RCSdirs
=`find . -name RCS -type d -print`
202 filesFromRCSfiles
='s|,v$||; s|/RCS/|/|; s|^\./||'
206 ?*) find $RCSdirs -type f -print
208 find . -name '*,v' -print
211 sed "$filesFromRCSfiles"
215 for file in RCS
/.
* RCS
/* .
*,v
*,v
218 RCS
/. | RCS
/..
) continue;;
219 RCS
/.\
* | RCS
/\
* | .\
*,v | \
*,v
) test -f "$file" ||
continue
233 llogout
=$TMPDIR/rcs2log$
$l
234 rlogout
=$TMPDIR/rcs2log$
$r
236 trap "rm -f $llogout $rlogout; exit 1" 0
238 case $rlog_options in
239 ?
*) $rlog $rlog_options ${1+"$@"} >$rlogout;;
240 '') $rlog "$datearg" ${1+"$@"} >$rlogout
244 # Get the full name of each author the logs mention, and set initialize_fullname
245 # to awk code that initializes the `fullname' awk associative array.
246 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
247 # you have to fix the resulting output by hand.
252 case $loginFullnameMailaddrs in
254 case $loginFullnameMailaddrs in
256 sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
257 $loginFullnameMailaddrs
259 loginFullnameMailaddrs
=`cat $llogout`
264 for loginFullnameMailaddr
in $loginFullnameMailaddrs
266 case $loginFullnameMailaddr in
270 set x
$loginFullnameMailaddr
274 initialize_fullname
="$initialize_fullname
275 fullname[\"$login\"] = \"$fullname\""
276 initialize_mailaddr
="$initialize_mailaddr
277 mailaddr[\"$login\"] = \"$mailaddr\""
283 ?
*) sort -u -o $llogout <<EOF || exit
287 output_authors
='/^date: / {
288 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 ~ /^[^;]*;$/) {
289 print substr($5, 1, length($5)-1)
293 $AWK "$output_authors" <$rlogout |
296 ?*) sort -u | comm -23 - $llogout
301 cat >$llogout <<EOF || exit
304 initialize_author_script
='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
305 initialize_author
=`sed -e "$initialize_author_script" <$llogout`
308 alphabet = "abcdefghijklmnopqrstuvwxyz"
309 ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
310 '"$initialize_author"'
315 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
316 # Remove the junk from fullnames like "0000-Admin(0000)".
317 fullname = substr(fullname, index(fullname, "-") + 1)
318 fullname = substr(fullname, 1, index(fullname, "(") - 1)
320 if (fullname ~ /,[^ ]/) {
321 # Some sites put comma-separated junk after the fullname.
322 # Remove it, but leave "Bill Gates, Jr" alone.
323 fullname = substr(fullname, 1, index(fullname, ",") - 1)
325 abbr = index(fullname, "&")
329 i = index(alphabet, a)
330 if (i) A = substr(ALPHABET, i, 1)
331 fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
334 # Quote quotes and backslashes properly in full names.
335 # Do not use gsub; traditional awk lacks it.
339 p = index(rest, "\\")
340 q = index(rest, "\"")
347 quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
348 rest = substr(rest, p+1)
351 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
357 initialize_fullname
=`
358 (cat /etc/passwd; ypmatch $authors passwd) 2>/dev/null |
359 $AWK -F: "$awkscript"
360 `$initialize_fullname
364 # Function to print a single log line.
365 # We don't use awk functions, to stay compatible with old awk versions.
366 # `Log' is the log message (with \n replaced by \r).
367 # `files' contains the affected files.
370 # Following the GNU coding standards, rewrite
371 # * file: (function): comment
373 # * file (function): comment
374 if (Log ~ /^\([^)]*\): /) {
376 files = files " " substr(Log, 1, i)
377 Log = substr(Log, i+3)
380 # If "label: comment" is too long, break the line after the ":".
382 if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, CR)) sep = "\n" indent_string
385 printf "%s*%s:", indent_string, files
387 # Print each line of the log, transliterating \r to \n.
388 while ((i = index(Log, CR)) != 0) {
389 logline = substr(Log, 1, i-1)
390 if (logline ~ /[^'"$tab"' ]/) {
391 printf "%s%s\n", sep, logline
396 Log = substr(Log, i+1)
403 hostname || uname -n || uuname -l || cat /etc/whoami
405 echo >&2 "$0: cannot deduce hostname"
411 # Process the rlog output, generating ChangeLog style entries.
413 # First, reformat the rlog output so that each line contains one log entry.
414 # Transliterate \n to \r so that multiline entries fit on a single line.
415 # Discard irrelevant rlog output.
417 BEGIN { repository = "'"$repository"'" }
419 if (repository != "") {
421 if (substr(filename, 1, length(repository) + 1) == repository "/") {
422 filename = substr(filename, length(repository) + 2)
424 if (filename ~ /,v$/) {
425 filename = substr(filename, 1, length(filename) - 2)
429 /^Working file:/ { if (repository == "") filename = $3 }
430 /^date: /, /^(-----------*|===========*)$/ {
431 if ($0 ~ /^branches: /) { next }
432 if ($0 ~ /^date: [0-9][- +\/0-9:]*;/) {
435 # An ISO format date. Replace all "-"s with "/"s.
437 while ((i = index(date, "-")) != 0) {
438 newdate = newdate substr(date, 1, i-1) "/"
439 date = substr(date, i+1)
443 # Ignore any time zone; ChangeLog has no room for it.
444 time = substr($3, 1, 8)
445 author = substr($5, 1, length($5)-1)
446 printf "%s %s %s %s %c", filename, date, time, author, 13
449 if ($0 ~ /^(-----------*|===========*)$/) { print ""; next }
450 printf "%s%c", $0, 13
454 # Now each line is of the form
455 # FILENAME YYYY/MM/DD HH:MM:SS AUTHOR \rLOG
456 # where \r stands for a carriage return,
457 # and each line of the log is terminated by \r instead of \n.
458 # Sort the log entries, first by date+time (in reverse order),
459 # then by author, then by log entry, and finally by file name (just in case).
462 # Finally, reformat the sorted log entries.
465 # Some awk variants do not understand "\r" or "\013", so we have to
466 # put a carriage return directly in the file.
467 CR="
" # <-- There is a single CR between the " chars here.
469 # Initialize the fullname and mailaddr associative arrays.
470 '"$initialize_fullname"'
471 '"$initialize_mailaddr"'
473 # Initialize indent string.
476 if (0 < '"$tabwidth"')
477 for (; '"$tabwidth"' <= i; i -= '"$tabwidth"')
478 indent_string = indent_string "\t"
480 indent_string = indent_string " "
482 # Set up date conversion tables.
483 # RCS uses a nice, clean, sortable format,
484 # but ChangeLog wants the traditional, ugly ctime format.
486 # January 1, 0 AD (Gregorian) was Saturday = 6
488 # Of course, there was no 0 AD, but the algorithm works anyway.
490 w[0]="Sun"; w[1]="Mon"; w[2]="Tue"; w[3]="Wed"
491 w[4]="Thu"; w[5]="Fri"; w[6]="Sat"
497 newlog = substr($0, 1 + index($0, CR))
499 # Ignore log entries prefixed by "#".
500 if (newlog ~ /^#/) { next }
502 if (Log != newlog || date != $2 || author != $4) {
504 # The previous log and this log differ.
507 if (date != "") '"$printlogline"'
509 # Logs that begin with "{clumpname} " should be grouped together,
510 # and the clumpname should be removed.
511 # Extract the new clumpname from the log header,
512 # and use it to decide whether to output a blank line.
515 if (date == "") sep = ""
516 if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
517 i = index(newlog, "}")
518 newclumpname = substr(newlog, 1, i)
519 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
520 newlog = substr(newlog, i+1)
521 if (clumpname == newclumpname) sep = ""
524 clumpname = newclumpname
526 # Get ready for the next log.
529 for (i in filesknown)
533 if (date != $2 || author != $4) {
534 # The previous date+author and this date+author differ.
539 # Convert nice RCS date like "1992/01/03 00:03:44"
540 # into ugly ctime date like "Fri Jan 3 00:03:44 1992".
541 # Calculate day of week from Gregorian calendar.
543 year = substr($2, 1, i-1) + 0
544 monthday = substr($2, i+1)
545 i = index(monthday, "/")
546 month = substr(monthday, 1, i-1) + 0
547 day = substr(monthday, i+1) + 0
549 if (2 < month && year%4 == 0 && (year%100 != 0 || year%400 == 0)) leap = 1
550 days_since_Sunday_before_epoch = EPOCH_WEEKDAY + year * 365 + int((year + 3) / 4) - int((year + 99) / 100) + int((year + 399) / 400) + mo[month-1] + leap + day - 1
552 # Print "date fullname (email address)".
553 # Get fullname and email address from associative arrays;
554 # default to author and author@hostname if not in arrays.
555 if (fullname[author])
556 auth = fullname[author]
559 printf "%s %s %2d %s %d %s ", w[days_since_Sunday_before_epoch%7], m[month-1], day, $3, year, auth
560 if (mailaddr[author])
561 printf "<%s>\n\n", mailaddr[author]
563 printf "<%s@%s>\n\n", author, "'"$hostname"'"
565 if (! filesknown[$1]) {
567 if (files == "") files = " " $1
568 else files = files ", " $1
572 # Print the last log.
583 exec rm -f $llogout $rlogout