lib-src/rcs2log

   1 #!/bin/sh
   2
   3 # RCS to ChangeLog generator
   4
   5 # Generate a change log prefix from RCS/* and the existing 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.
   8
   9 # Ignore log entries that start with `#'.
  10 # Clump together log entries that start with `{topic} ',
  11 # where `topic' contains neither white space nor `}'.
  12
  13 # Author: Paul Eggert <eggert@twinsun.com>
  14
  15 # $Id: rcs2log,v 1.8 1992/09/27 01:55:21 roland Exp eggert $
  16
  17 # Copyright 1992, 1993 Free Software Foundation, Inc.
  18
  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)
  22 # any later version.
  23 #
  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.
  28 #
  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.
  32
  33
  34 # Parse options.
  35
  36 # defaults
  37 indent=8 # indent of log line
  38 length=79 # suggested max width of log line
  39 tabwidth=8 # width of horizontal tab
  40
  41 while :
  42 do
  43         case $1 in
  44         -i)     indent=${2?};;
  45         -l)     length=${2?};;
  46         -t)     tabwidth=${2?};;
  47         -*)     echo >&2 "$0: usage: $0 [-i indent] [-l length] [-t tabwidth] [file ...]"
  48                 exit 1;;
  49         *)      break
  50         esac
  51         shift; shift
  52 done
  53
  54
  55 # Log into $rlogout the revisions checked in since the first ChangeLog entry.
  56
  57 date=1970
  58 if test -s ChangeLog
  59 then
  60         # Add 1 to seconds to avoid duplicating most recent log.
  61         # It's a good thing `rlog' doesn't mind a time ending in `:60'.
  62         e='
  63                 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
  64                         printf "%s%02d %s\n", substr($0,1,17), substr($0,18,2)+1, $5
  65                         exit
  66                 }
  67         '
  68         d=`awk "$e" <ChangeLog` || exit
  69         case $d in
  70         ?*) date=$d
  71         esac
  72 fi
  73 datearg="-d>$date"
  74
  75 rlogout=/tmp/chg$$
  76 trap exit 1 2 13 15
  77 trap 'rm -f $rlogout; exit 1' 0
  78
  79 case $# in
  80 0) set RCS/*
  81 esac
  82
  83 rlog "$datearg" "$@" >$rlogout || exit
  84
  85
  86 # Get the full name of each author the logs mention, and set initialize_fullname
  87 # to awk code that initializes the `fullname' awk associative array.
  88 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
  89 # you have to fix the resulting output by hand.
  90
  91 initialize_fullname=
  92 authors=`
  93         sed -n 's|^date: *[0-9]*/[0-9][0-9]/[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9]; *author: *\([^; ]*\).*|\1|p' <$rlogout |
  94         sort -u
  95 `
  96 case $authors in
  97 ?*)
  98         initialize_author=
  99         for author in $authors
 100         do
 101                 initialize_author="$initialize_author
 102                         author[\"$author\"] = 1
 103                 "
 104         done
 105
 106         awkscript='
 107                 BEGIN {
 108                         alphabet = "abcdefghijklmnopqrstuvwxyz"
 109                         ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 110                         '"$initialize_author"'
 111                 }
 112                 {
 113                         if (author[$1]) {
 114                                 fullname = $5
 115                                 abbr = index(fullname, "&")
 116                                 if (abbr) {
 117                                         a = substr($1, 1, 1)
 118                                         A = a
 119                                         i = index(alphabet, a)
 120                                         if (i) A = substr(ALPHABET, i, 1)
 121                                         fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
 122                                 }
 123                                 printf "fullname[\"%s\"] = \"%s\"\n", $1, fullname
 124                                 author[$1] = 0
 125                         }
 126                 }
 127         '
 128
 129         initialize_fullname=`
 130                 (cat /etc/passwd; ypmatch $authors passwd) 2>/dev/null |
 131                 awk -F: "$awkscript"
 132         `
 133 esac
 134
 135
 136 # Function to print a single log line.
 137 # We don't use awk functions, to stay compatible with old awk versions.
 138 # `Log' is the log message (with \n replaced by \r).
 139 # `files' contains the affected files.
 140 printlogline='{
 141
 142         # Following the GNU coding standards, rewrite
 143         #       * file: (function): comment
 144         # to
 145         #       * file (function): comment
 146         if (Log ~ /^\([^)]*\): /) {
 147                 i = index(Log, ")")
 148                 files = files " " substr(Log, 1, i)
 149                 Log = substr(Log, i+3)
 150         }
 151
 152         # If "label: comment" is too long, break the line after the ":".
 153         sep = " "
 154         if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, "\r")) sep = "\n" indent_string
 155
 156         # Print the label.
 157         printf "%s*%s:", indent_string, files
 158
 159         # Print each line of the log, transliterating \r to \n.
 160         while ((i = index(Log, "\r")) != 0) {
 161                 printf "%s%s\n", sep, substr(Log, 1, i-1)
 162                 sep = indent_string
 163                 Log = substr(Log, i+1)
 164         }
 165 }'
 166
 167 hostname=`(
 168         hostname || cat /etc/whoami || uuname -l || uname -n
 169 ) 2>/dev/null` || {
 170         echo >&2 "$0: cannot deduce hostname"
 171         exit 1
 172 }
 173
 174
 175 # Process the rlog output, generating ChangeLog style entries.
 176
 177 # First, reformat the rlog output so that each line contains one log entry.
 178 # Transliterate \n to \r so that multiline entries fit on a single line.
 179 # Discard irrelevant rlog output.
 180 awk <$rlogout '
 181         /^Working file:/ { filename = $3 }
 182         /^date: /, /^(-----------*|===========*)$/ {
 183                 if ($0 ~ /^branches: /) { next }
 184                 if ($0 ~ /^date: [0-9][ /0-9:]*;/) {
 185                         time = substr($3, 1, length($3)-1)
 186                         author = substr($5, 1, length($5)-1)
 187                         printf "%s %s %s %s \r", filename, $2, time, author
 188                         next
 189                 }
 190                 if ($0 ~ /^(-----------*|===========*)$/) { print ""; next }
 191                 printf "%s\r", $0
 192         }
 193 ' |
 194
 195 # Now each line is of the form
 196 # FILENAME YYYY/MM/DD HH:MM:SS AUTHOR \rLOG
 197 #       where \r stands for a carriage return,
 198 #       and each line of the log is terminated by \r instead of \n.
 199 # Sort the log entries, first by date+time (in reverse order),
 200 # then by author, then by log entry, and finally by file name (just in case).
 201 sort +1 -3r +3 +0 |
 202
 203 # Finally, reformat the sorted log entries.
 204 awk '
 205         BEGIN {
 206
 207                 # Initialize the fullname associative array.
 208                 '"$initialize_fullname"'
 209
 210                 # Initialize indent string.
 211                 indent_string = ""
 212                 i = '"$indent"'
 213                 if (0 < '"$tabwidth"')
 214                         for (;  '"$tabwidth"' <= i;  i -= '"$tabwidth"')
 215                                 indent_string = indent_string "\t"
 216                 while (1 <= i--)
 217                         indent_string = indent_string " "
 218
 219                 # Set up date conversion tables.
 220                 # RCS uses a nice, clean, sortable format,
 221                 # but ChangeLog wants the traditional, ugly ctime format.
 222
 223                 # January 1, 0 AD (Gregorian) was Saturday = 6
 224                 EPOCH_WEEKDAY = 6
 225                 # Of course, there was no 0 AD, but the algorithm works anyway.
 226
 227                 w[0]="Sun"; w[1]="Mon"; w[2]="Tue"; w[3]="Wed"
 228                 w[4]="Thu"; w[5]="Fri"; w[6]="Sat"
 229
 230                 m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
 231                 m[3]="Apr"; m[4]="May"; m[5]="Jun"
 232                 m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
 233                 m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
 234
 235                 # days in non-leap year thus far, indexed by month (0-12)
 236                 mo[0]=0; mo[1]=31; mo[2]=59; mo[3]=90
 237                 mo[4]=120; mo[5]=151; mo[6]=181; mo[7]=212
 238                 mo[8]=243; mo[9]=273; mo[10]=304; mo[11]=334
 239                 mo[12]=365
 240         }
 241
 242         {
 243                 newlog = substr($0, 1 + index($0, "\r"))
 244
 245                 # Ignore log entries prefixed by "#".
 246                 if (newlog ~ /^#/) { next }
 247
 248                 if (Log != newlog || date != $2 || author != $4) {
 249
 250                         # The previous log and this log differ.
 251
 252                         # Print the old log.
 253                         if (date != "") '"$printlogline"'
 254
 255                         # Logs that begin with "{clumpname} " should be grouped together,
 256                         # and the clumpname should be removed.
 257                         # Extract the new clumpname from the log header,
 258                         # and use it to decide whether to output a blank line.
 259                         newclumpname = ""
 260                         sep = "\n"
 261                         if (date == "") sep = ""
 262                         if (newlog ~ /^{[^       }]*}[   ]/) {
 263                                 i = index(newlog, "}")
 264                                 newclumpname = substr(newlog, 1, i)
 265                                 while (substr(newlog, i+1) ~ /^[         ]/) i++
 266                                 newlog = substr(newlog, i+1)
 267                                 if (clumpname == newclumpname) sep = ""
 268                         }
 269                         printf sep
 270                         clumpname = newclumpname
 271
 272                         # Get ready for the next log.
 273                         Log = newlog
 274                         if (files != "")
 275                                 for (i in filesknown)
 276                                         filesknown[i] = 0
 277                         files = ""
 278                 }
 279                 if (date != $2  ||  author != $4) {
 280                         # The previous date+author and this date+author differ.
 281                         # Print the new one.
 282                         date = $2
 283                         author = $4
 284
 285                         # Convert nice RCS date like "1992/01/03 00:03:44"
 286                         # into ugly ctime date like "Fri Jan  3 00:03:44 1992".
 287                         # Calculate day of week from Gregorian calendar.
 288                         i = index($2, "/")
 289                         year = substr($2, 1, i-1) + 0
 290                         monthday = substr($2, i+1)
 291                         i = index(monthday, "/")
 292                         month = substr(monthday, 1, i-1) + 0
 293                         day = substr(monthday, i+1) + 0
 294                         leap = 0
 295                         if (2 < month && year%4 == 0 && (year%100 != 0 || year%400 == 0)) leap = 1
 296                         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
 297
 298                         # Print "date  fullname  (email address)" if the fullname is known;
 299                         # print "date  author" otherwise.
 300                         # Get the fullname from the associative array.
 301                         # The email address is just author@thishostname.
 302                         printf "%s %s %2d %s %d  ", w[days_since_Sunday_before_epoch%7], m[month-1], day, $3, year
 303                         if (fullname[author])
 304                                 printf "%s  (%s@%s)\n\n", fullname[author], author, "'"$hostname"'"
 305                         else
 306                                 printf "%s\n\n", author
 307                 }
 308                 if (! filesknown[$1]) {
 309                         filesknown[$1] = 1
 310                         if (files == "") files = " " $1
 311                         else files = files ", " $1
 312                 }
 313         }
 314         END {
 315                 # Print the last log.
 316                 if (date != "") {
 317                         '"$printlogline"'
 318                         printf "\n"
 319                 }
 320         }
 321 ' &&
 322
 323
 324 # Exit successfully.
 325
 326 exec rm -f $rlogout