X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/d74a9f24b3c852e47e5ab0b6e862a1544fda2ef7..f2260f48b09bc32ae620f26e797b85165152baf8:/lib-src/rcs2log diff --git a/lib-src/rcs2log b/lib-src/rcs2log index d6abdeb0d0..19f5a2b26b 100755 --- a/lib-src/rcs2log +++ b/lib-src/rcs2log @@ -2,35 +2,60 @@ # RCS to ChangeLog generator -# Generate a change log prefix from RCS files (perhaps in the CVS repository) -# and the ChangeLog (if any). -# Output the new prefix to standard output. -# You can edit this prefix by hand, and then prepend it to ChangeLog. +Help=' +Generate ChangeLog entries from RCS files (perhaps in a CVS repository) +and the ChangeLog file (if any). An RCS file typically has a name +ending in ",v", and represents the entire history of a file that is +under revision control. The ChangeLog file logs entries for changes, +in reverse chronological order. -# Ignore log entries that start with `#'. -# Clump together log entries that start with `{topic} ', -# where `topic' contains neither white space nor `}'. +Generate entries for changes entered into RCS (or CVS) more recently +than the newest existing entry in the ChangeLog file. You can then +edit these entries by hand, and prepend them to the ChangeLog file. + +Output the resulting ChangeLog entries to standard output. +Each entry looks something like this: + +2004-04-17 Paul Eggert + + * rcs2log (Help): Clarify wording of the usage message. + Problem reported by Alan Mackenzie in + . + +ChangeLog entries contain the current date, full name, email address +including hostname, the name of the affected file, and commentary. +RCS and CVS logs lack full names and email addresses, so they are +inferred from login names using a heuristic that can be overridden +via the -u option. + +Ignore log entries that start with "#". +Clump together log entries that start with "{topic} ", +where "topic" contains neither white space nor "}". + +If no FILE is specified, use all files under the working directory +that are maintained under version control. -Help='The default FILEs are the files registered under the working directory. Options: - -c CHANGELOG Output a change log prefix to CHANGELOG (default ChangeLog). + -c FILE Output ChangeLog entries for FILE (default ChangeLog). -h HOSTNAME Use HOSTNAME in change log entries (default current host). -i INDENT Indent change log lines by INDENT spaces (default 8). -l LENGTH Try to limit log lines to LENGTH characters (default 79). + -L FILE Use FILE (same format as "rlog") for source of logs. -R If no FILEs are given and RCS is used, recurse through working directory. - -r OPTION Pass OPTION to subsidiary log command. + -r OPTION Pass OPTION to subsidiary command (either "rlog" or "cvs -q log"). -t TABWIDTH Tab stops are every TABWIDTH characters (default 8). - -u "LOGINFULLNAMEMAILADDR" Assume LOGIN has FULLNAME and MAILADDR. + -u "LOGINFULLNAMEEMAILADDR" LOGIN has FULLNAME and EMAILADDR. -v Append RCS revision to file names in log lines. --help Output help. --version Output version number. -Report bugs to .' +Report bugs to .' -Id='$Id: rcs2log,v 1.39 1997/05/11 18:43:55 eggert Exp eggert $' +Id='$Id: rcs2log,v 1.53 2004/02/15 07:41:58 uid65632 Exp $' -# Copyright 1992, 1993, 1994, 1995, 1996, 1997 Free Software Foundation, Inc. +# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2002, 2003, +# 2004 Free Software Foundation, Inc. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -47,13 +72,29 @@ Id='$Id: rcs2log,v 1.39 1997/05/11 18:43:55 eggert Exp eggert $' # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. -Copyright='Copyright 1997 Free Software Foundation, Inc. +Copyright='Copyright (C) 2004 Free Software Foundation, Inc. This program comes with NO WARRANTY, to the extent permitted by law. You may redistribute copies of this program under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING. Author: Paul Eggert ' +# Use the traditional C locale. +LANG=C +LANGUAGE=C +LC_ALL=C +LC_COLLATE=C +LC_CTYPE=C +LC_MESSAGES=C +LC_NUMERIC=C +LC_TIME=C +export LANG LANGUAGE LC_ALL LC_COLLATE LC_CTYPE LC_MESSAGES LC_NUMERIC LC_TIME + +# These variables each contain a single ASCII character. +# Unfortunately, there's no portable way of writing these characters +# in older Unix implementations, other than putting them directly into +# this text file. +SOH='' # SOH, octal code 001 tab=' ' nl=' ' @@ -61,8 +102,8 @@ nl=' # Parse options. # defaults -: ${AWK=awk} -: ${TMPDIR=/tmp} +AWK=${AWK-awk} +TMPDIR=${TMPDIR-/tmp} changelog=ChangeLog # change log file name datearg= # rlog date option hostname= # name of local host (if empty, will deduce it later) @@ -74,6 +115,7 @@ logTZ= # time zone for log dates (if empty, use local time) recursive= # t if we want recursive rlog revision= # t if we want revision numbers rlog_options= # options to pass to rlog +rlogfile= # log file to read from tabwidth=8 # width of horizontal tab while : @@ -83,17 +125,16 @@ do -i) indent=${2?}; shift;; -h) hostname=${2?}; shift;; -l) length=${2?}; shift;; + -L) rlogfile=${2?}; shift;; -[nu]) # -n is obsolescent; it is replaced by -u. case $1 in -n) case ${2?}${3?}${4?} in *"$tab"* | *"$nl"*) echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed" - exit 1 - esac - case $loginFullnameMailaddrs in - '') loginFullnameMailaddrs=$2$tab$3$tab$4;; - ?*) loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$2$tab$3$tab$4 + exit 1;; esac + login=$2 + lfm=$2$tab$3$tab$4 shift; shift; shift;; -u) # If $2 is not tab-separated, use colon for separator. @@ -104,33 +145,39 @@ do *"$tab"*) t=$tab;; *) - t=: + t=':';; esac case $2 in *"$t"*"$t"*"$t"*) echo >&2 "$0: -u '$2': too many fields" exit 1;; *"$t"*"$t"*) - ;; + uf="[^$t]*$t" # An unselected field, followed by a separator. + sf="\\([^$t]*\\)" # The selected field. + login=`expr "X$2" : "X$sf"` + lfm="$login$tab"` + expr "X$2" : "$uf$sf" + `"$tab"` + expr "X$2" : "$uf$uf$sf" + `;; *) echo >&2 "$0: -u '$2': not enough fields" - exit 1 - esac - case $loginFullnameMailaddrs in - '') loginFullnameMailaddrs=$2;; - ?*) loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$2 + exit 1;; esac - shift + shift;; esac case $logins in '') logins=$login;; - ?*) logins=$logins$nl$login + ?*) logins=$logins$nl$login;; esac - ;; + case $loginFullnameMailaddrs in + '') loginFullnameMailaddrs=$lfm;; + ?*) loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$lfm;; + esac;; -r) case $rlog_options in '') rlog_options=${2?};; - ?*) rlog_options=$rlog_options$nl${2?} + ?*) rlog_options=$rlog_options$nl${2?};; esac shift;; -R) recursive=t;; @@ -144,9 +191,9 @@ do -*) echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help" case $1 in --help) exit 0;; - *) exit 1 + *) exit 1;; esac;; - *) break + *) break;; esac shift done @@ -158,155 +205,204 @@ month_data=' m[9]="Oct"; m[10]="Nov"; m[11]="Dec" ' +logdir=$TMPDIR/rcs2log$$ +llogout=$logdir/l +trap exit 1 2 13 15 +trap "rm -fr $logdir 2>/dev/null" 0 +(umask 077 && exec mkdir $logdir) || exit -# Put rlog output into $rlogout. - -# If no rlog options are given, -# log the revisions checked in since the first ChangeLog entry. -# Since ChangeLog is only by date, some of these revisions may be duplicates of -# what's already in ChangeLog; it's the user's responsibility to remove them. -case $rlog_options in +# If no rlog-format log file is given, generate one into $rlogfile. +case $rlogfile in '') + rlogfile=$logdir/r + + # If no rlog options are given, + # log the revisions checked in since the first ChangeLog entry. + # Since ChangeLog is only by date, some of these revisions may be + # duplicates of what's already in ChangeLog; it's the user's + # responsibility to remove them. + case $rlog_options in + '') + if test -s "$changelog" + then + e=' + /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{ + # ISO 8601 date + print $1 + exit + } + /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{ + # old-fashioned date and time (Emacs 19.31 and earlier) + '"$month_data"' + year = $5 + for (i=0; i<=11; i++) if (m[i] == $2) break + dd = $3 + printf "%d-%02d-%02d\n", year, i+1, dd + exit + } + ' + d=`$AWK "$e" <"$changelog"` || exit + case $d in + ?*) datearg="-d>$d";; + esac + fi;; + esac + + # Use TZ specified by ChangeLog local variable, if any. if test -s "$changelog" then - e=' - /^[0-9]+-[0-9][0-9]-[0-9][0-9]/{ - # ISO 8601 date - print $1 - exit + extractTZ=' + /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{ + s//\1/; p; q } - /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{ - # old-fashioned date and time (Emacs 19.31 and earlier) - '"$month_data"' - year = $5 - for (i=0; i<=11; i++) if (m[i] == $2) break - dd = $3 - printf "%d-%02d-%02d\n", year, i+1, dd - exit + /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{ + s//UTC0/; p; q } ' - d=`$AWK "$e" <"$changelog"` || exit - case $d in - ?*) datearg="-d>$d" + logTZ=`tail "$changelog" | sed -n "$extractTZ"` + case $logTZ in + ?*) TZ=$logTZ; export TZ;; esac fi -esac -# Use TZ specified by ChangeLog local variable, if any. -if test -s "$changelog" -then - extractTZ=' - /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{ - s//\1/; p; q - } - /^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{ - s//UTC0/; p; q - } - ' - logTZ=`tail "$changelog" | sed -n "$extractTZ"` - case $logTZ in - ?*) TZ=$logTZ; export TZ - esac -fi - -# If CVS is in use, examine its repository, not the normal RCS files. -if test ! -f CVS/Repository -then - rlog=rlog - repository= -else - rlog='cvs -q log' - repository=`sed 1q &2 "$0: $repository: bad repository (see CVS/Repository)" + exit 1 + fi + pository=$repository;; esac - if test ! -d "$repository" - then - echo >&2 "$0: $repository: bad repository (see CVS/Repository)" - exit 1 - fi - esac -fi -# Use $rlog's -zLT option, if $rlog supports it. -case `$rlog -zLT 2>&1` in -*' option'*) ;; -*) - case $rlog_options in - '') rlog_options=-zLT;; - ?*) rlog_options=-zLT$nl$rlog_options + # Ensure that $pository ends in exactly one slash. + while : + do + case $pository in + *//) pository=`expr "X$pository" : 'X\(.*\)/'`;; + */) break;; + *) pository=$pository/; break;; + esac + done + + # If no rlog options are given, and if we are in a tagged CVS branch, + # log only the changes in that branch. + case $rlog_options in + '') + if test -f CVS/Tag + then + CVSTAG=`cat &2 "$0: invalid CVS/Tag"; exit 1;; + esac + fi;; + esac + fi + + # Use $rlog's -zLT option, if $rlog supports it. + case `$rlog -zLT 2>&1` in + *' option'*) ;; + *) + case $rlog_options in + '') rlog_options=-zLT;; + ?*) rlog_options=-zLT$nl$rlog_options;; + esac;; esac -esac -# With no arguments, examine all files under the RCS directory. -case $# in -0) - case $repository in - '') - oldIFS=$IFS - IFS=$nl - case $recursive in - t) - RCSdirs=`find . -name RCS -type d -print` - filesFromRCSfiles='s|,v$||; s|/RCS/|/|; s|^\./||' - files=` - { - case $RCSdirs in - ?*) find $RCSdirs \ - -type f \ - ! -name '*_' \ - ! -name ',*,' \ - ! -name '.*_' \ - ! -name .rcsfreeze.log \ - ! -name .rcsfreeze.ver \ - -print + # With no arguments, examine all files under the RCS directory. + case $# in + 0) + case $repository in + '') + oldIFS=$IFS + IFS=$nl + case $recursive in + t) + RCSdirs=`find . -name RCS -type d -print` + filesFromRCSfiles='s|,v$||; s|/RCS/|/|; s|^\./||' + files=` + { + case $RCSdirs in + ?*) find $RCSdirs \ + -type f \ + ! -name '*_' \ + ! -name ',*,' \ + ! -name '.*_' \ + ! -name .rcsfreeze.log \ + ! -name .rcsfreeze.ver \ + -print;; + esac + find . -name '*,v' -print + } | + sort -u | + sed "$filesFromRCSfiles" + `;; + *) + files= + for file in RCS/.* RCS/* .*,v *,v + do + case $file in + RCS/. | RCS/.. | RCS/,*, | RCS/*_) continue;; + RCS/.rcsfreeze.log | RCS/.rcsfreeze.ver) continue;; + RCS/.\* | RCS/\* | .\*,v | \*,v) test -f "$file" || continue;; + RCS/*,v | RCS/.*,v) ;; + RCS/* | RCS/.*) test -f "$file" || continue;; esac - find . -name '*,v' -print - } | - sort -u | - sed "$filesFromRCSfiles" - `;; - *) - files= - for file in RCS/.* RCS/* .*,v *,v - do - case $file in - RCS/. | RCS/.. | RCS/,*, | RCS/*_) continue;; - RCS/.rcsfreeze.log | RCS/.rcsfreeze.ver) continue;; - RCS/.\* | RCS/\* | .\*,v | \*,v) test -f "$file" || continue - esac + case $files in + '') files=$file;; + ?*) files=$files$nl$file;; + esac + done case $files in - '') files=$file;; - ?*) files=$files$nl$file - esac - done - case $files in - '') exit 0 + '') exit 0;; + esac;; esac - esac - set x $files - shift - IFS=$oldIFS + set x $files + shift + IFS=$oldIFS;; + esac;; esac + + case $datearg in + ?*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogfile;; + '') $rlog $rlog_options ${1+"$@"} >$rlogfile;; + esac || exit;; esac -llogout=$TMPDIR/rcs2log$$l -rlogout=$TMPDIR/rcs2log$$r -trap exit 1 2 13 15 -trap "rm -f $llogout $rlogout; exit 1" 0 -case $datearg in -?*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogout;; -'') $rlog $rlog_options ${1+"$@"} >$rlogout -esac || exit +# Prefer the POSIX-style -k options, since POSIX 1003.1-2001 prohibits +# support for the traditional-style +M -N options. +SORT_K_OPTIONS='-k 3,4r -k 5 -k 1' +sort $SORT_K_OPTIONS /dev/null || SORT_K_OPTIONS='+2 -4r +4 +0' # Get the full name of each author the logs mention, and set initialize_fullname @@ -324,17 +420,14 @@ case $loginFullnameMailaddrs in sed 's/["\\]/\\&/g' >$llogout <$llogout || exit + output_authors='/^date: / { 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 ~ /^[^;]*;$/) { print substr($5, 1, length($5)-1) } }' authors=` - $AWK "$output_authors" <$rlogout | - case $llogout in - '') sort -u;; - ?*) sort -u | comm -23 - $llogout - esac + $AWK "$output_authors" <"$rlogfile" | sort -u | comm -23 - $llogout ` case $authors in ?*) @@ -423,21 +517,24 @@ EOF ' initialize_fullname=` - ( - cat /etc/passwd - for author in $authors - do NIS_PATH= nismatch $author passwd.org_dir - done - ypmatch $authors passwd - ) 2>/dev/null | + { + (getent passwd $authors) || + ( + cat /etc/passwd + for author in $authors + do NIS_PATH= nismatch $author passwd.org_dir + done + ypmatch $authors passwd + ) + } 2>/dev/null | $AWK -F: "$awkscript" - `$initialize_fullname + `$initialize_fullname;; esac # Function to print a single log line. # We don't use awk functions, to stay compatible with old awk versions. -# `Log' is the log message (with \n replaced by \001). +# `Log' is the log message. # `files' contains the affected files. printlogline='{ @@ -445,21 +542,27 @@ printlogline='{ # * file: (function): comment # to # * file (function): comment - if (Log ~ /^\([^)]*\): /) { + if (Log ~ /^\([^)]*\):[\t\n ]/) { i = index(Log, ")") - files = files " " substr(Log, 1, i) + filefunc = substr(Log, 1, i) + while ((j = index(filefunc, "\n"))) { + files = files " " substr(filefunc, 1, j-1) + filefunc = substr(filefunc, j+1) + } + files = files " " filefunc Log = substr(Log, i+3) } # If "label: comment" is too long, break the line after the ":". sep = " " - if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, SOH)) sep = "\n" indent_string + i = index(Log, "\n") + if ('"$length"' <= '"$indent"' + 1 + length(files) + i) sep = "\n" indent_string # Print the label. printf "%s*%s:", indent_string, files - # Print each line of the log, transliterating \001 to \n. - while ((i = index(Log, SOH)) != 0) { + # Print each line of the log. + while (i) { logline = substr(Log, 1, i-1) if (logline ~ /[^'"$tab"' ]/) { printf "%s%s\n", sep, logline @@ -468,6 +571,7 @@ printlogline='{ } sep = indent_string Log = substr(Log, i+1) + i = index(Log, "\n") } }' @@ -488,24 +592,27 @@ case $hostname in *) domainname=`(domainname) 2>/dev/null` && case $domainname in - *.*) hostname=$hostname.$domainname - esac - esac + *.*) hostname=$hostname.$domainname;; + esac;; + esac;; esac # Process the rlog output, generating ChangeLog style entries. # First, reformat the rlog output so that each line contains one log entry. -# Transliterate \n to \001 so that multiline entries fit on a single line. +# Transliterate \n to SOH so that multiline entries fit on a single line. # Discard irrelevant rlog output. -$AWK <$rlogout ' - BEGIN { repository = "'"$repository"'" } - /^RCS file:/ { - if (repository != "") { - filename = $3 - if (substr(filename, 1, length(repository) + 1) == repository "/") { - filename = substr(filename, length(repository) + 2) +$AWK ' + BEGIN { + pository = "'"$pository"'" + SOH="'"$SOH"'" + } + /^RCS file: / { + if (pository != "") { + filename = substr($0, 11) + if (substr(filename, 1, length(pository)) == pository) { + filename = substr(filename, length(pository) + 1) } if (filename ~ /,v$/) { filename = substr(filename, 1, length(filename) - 2) @@ -518,13 +625,14 @@ $AWK <$rlogout ' } rev = "?" } - /^Working file:/ { if (repository == "") filename = $3 } + /^Working file: / { if (repository == "") filename = substr($0, 15) } /'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ { - if ($0 ~ /'"$rlog_revision_pattern"'/) { + line = $0 + if (line ~ /'"$rlog_revision_pattern"'/) { rev = $2 next } - if ($0 ~ /^date: [0-9][- +\/0-9:]*;/) { + if (line ~ /^date: [0-9][- +\/0-9:]*;/) { date = $2 if (date ~ /\//) { # This is a traditional RCS format date YYYY/MM/DD. @@ -538,38 +646,34 @@ $AWK <$rlogout ' } time = substr($3, 1, length($3) - 1) author = substr($5, 1, length($5)-1) - printf "%s %s %s %s %s %c", filename, rev, date, time, author, 1 + printf "%s%s%s%s%s%s%s%s%s%s", filename, SOH, rev, SOH, date, SOH, time, SOH, author, SOH rev = "?" next } - if ($0 ~ /^branches: /) { next } - if ($0 ~ /^(-----------*|===========*)$/) { print ""; next } - if ($0 == "Initial revision" || $0 ~ /^file .+ was initially added on branch .+\.$/) { - $0 = "New file." - } - printf "%s%c", $0, 1 + if (line ~ /^branches: /) { next } + if (line ~ /^(-----------*|===========*)$/) { print ""; next } + if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) { + line = "New file." + } + printf "%s%s", line, SOH } -' | +' <"$rlogfile" | # Now each line is of the form -# FILENAME REVISION YYYY-MM-DD HH:MM:SS[+-TIMEZONE] AUTHOR \001LOG -# where \001 stands for a carriage return, -# and each line of the log is terminated by \001 instead of \n. +# FILENAME@REVISION@YYYY-MM-DD@HH:MM:SS[+-TIMEZONE]@AUTHOR@LOG +# where @ stands for an SOH (octal code 001), +# and each line of LOG is terminated by SOH instead of \n. # Sort the log entries, first by date+time (in reverse order), # then by author, then by log entry, and finally by file name and revision # (just in case). -sort +2 -4r +4 +0 | +sort -t"$SOH" $SORT_K_OPTIONS | # Finally, reformat the sorted log entries. -$AWK ' +$AWK -F"$SOH" ' BEGIN { logTZ = "'"$logTZ"'" revision = "'"$revision"'" - # Some awk variants do not understand "\001", so we have to - # put the char directly in the file. - SOH="" # <-- There is a single SOH (octal code 001) here. - # Initialize the fullname and mailaddr associative arrays. '"$initialize_fullname"' '"$initialize_mailaddr"' @@ -585,7 +689,8 @@ $AWK ' } { - newlog = substr($0, 1 + index($0, SOH)) + newlog = "" + for (i = 6; i < NF; i++) newlog = newlog $i "\n" # Ignore log entries prefixed by "#". if (newlog ~ /^#/) { next } @@ -609,7 +714,7 @@ $AWK ' newclumpname = substr(newlog, 1, i) while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++ newlog = substr(newlog, i+1) - if (clumpname == newclumpname) sep = "" + if (clumpname == newclumpname && date == $3 && author == $5) sep = "" } printf sep clumpname = newclumpname @@ -664,8 +769,10 @@ $AWK ' # Exit successfully. -exec rm -f $llogout $rlogout +exec rm -fr $logdir # Local Variables: # tab-width:4 # End: + +# arch-tag: cea067bd-a552-4254-ba17-078208933073