rcs2log 20.6 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1 2 3 4
#! /bin/sh

# RCS to ChangeLog generator

Paul Eggert's avatar
Paul Eggert committed
5
# Copyright (C) 1992-1998, 2001-2015 Free Software Foundation, Inc.
6

Glenn Morris's avatar
Glenn Morris committed
7 8
# Author: Paul Eggert <eggert@twinsun.com>

9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 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
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


Paul Eggert's avatar
Paul Eggert committed
23
Copyright='Copyright (C) 2015 Free Software Foundation, Inc.
24 25 26 27 28 29
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 <eggert@twinsun.com>'

30 31 32 33 34 35
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.
Gerd Moellmann's avatar
Gerd Moellmann committed
36

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
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  <eggert@gnu.org>

	* rcs2log (Help): Clarify wording of the usage message.
	Problem reported by Alan Mackenzie in
	<http://mail.gnu.org/archive/html/bug-gnu-emacs/2004-04/msg00188.html>.

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.
Gerd Moellmann's avatar
Gerd Moellmann committed
62 63 64

Options:

65
  -c FILE  Output ChangeLog entries for FILE (default ChangeLog).
Gerd Moellmann's avatar
Gerd Moellmann committed
66 67 68
  -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).
69
  -L FILE  Use FILE (same format as "rlog") for source of logs.
Gerd Moellmann's avatar
Gerd Moellmann committed
70
  -R  If no FILEs are given and RCS is used, recurse through working directory.
71
  -r OPTION  Pass OPTION to subsidiary command (either "rlog" or "cvs -q log").
Gerd Moellmann's avatar
Gerd Moellmann committed
72
  -t TABWIDTH  Tab stops are every TABWIDTH characters (default 8).
73
  -u "LOGIN<tab>FULLNAME<tab>EMAILADDR"  LOGIN has FULLNAME and EMAILADDR.
Gerd Moellmann's avatar
Gerd Moellmann committed
74 75 76 77 78 79
  -v  Append RCS revision to file names in log lines.
  --help  Output help.
  --version  Output version number.

Report bugs to <bug-gnu-emacs@gnu.org>.'

Lute Kamstra's avatar
Lute Kamstra committed
80
Id='$Id$'
Gerd Moellmann's avatar
Gerd Moellmann committed
81

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
# 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
Gerd Moellmann's avatar
Gerd Moellmann committed
98 99 100 101 102 103 104
tab='	'
nl='
'

# Parse options.

# defaults
Paul Eggert's avatar
Paul Eggert committed
105 106
AWK=${AWK-awk}
TMPDIR=${TMPDIR-/tmp}
Gerd Moellmann's avatar
Gerd Moellmann committed
107 108 109 110 111 112 113 114 115 116 117
changelog=ChangeLog # change log file name
datearg= # rlog date option
hostname= # name of local host (if empty, will deduce it later)
indent=8 # indent of log line
length=79 # suggested max width of log line
logins= # login names for people we know fullnames and mailaddrs of
loginFullnameMailaddrs= # login<tab>fullname<tab>mailaddr triplets
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
118
rlogfile= # log file to read from
Gerd Moellmann's avatar
Gerd Moellmann committed
119 120 121 122 123 124 125 126 127
tabwidth=8 # width of horizontal tab

while :
do
	case $1 in
	-c)	changelog=${2?}; shift;;
	-i)	indent=${2?}; shift;;
	-h)	hostname=${2?}; shift;;
	-l)	length=${2?}; shift;;
128
	-L)	rlogfile=${2?}; shift;;
Gerd Moellmann's avatar
Gerd Moellmann committed
129 130 131 132 133
	-[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"
134
				exit 1;;
Gerd Moellmann's avatar
Gerd Moellmann committed
135
			esac
136 137
			login=$2
			lfm=$2$tab$3$tab$4
Gerd Moellmann's avatar
Gerd Moellmann committed
138 139 140 141 142 143 144 145 146 147
			shift; shift; shift;;
		-u)
			# If $2 is not tab-separated, use colon for separator.
			case ${2?} in
			*"$nl"*)
				echo >&2 "$0: -u '$2': newlines not allowed"
				exit 1;;
			*"$tab"*)
				t=$tab;;
			*)
148
				t=':';;
Gerd Moellmann's avatar
Gerd Moellmann committed
149 150 151 152 153 154
			esac
			case $2 in
			*"$t"*"$t"*"$t"*)
				echo >&2 "$0: -u '$2': too many fields"
				exit 1;;
			*"$t"*"$t"*)
155 156 157 158 159 160 161 162
				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"
				`;;
Gerd Moellmann's avatar
Gerd Moellmann committed
163 164
			*)
				echo >&2 "$0: -u '$2': not enough fields"
165
				exit 1;;
Gerd Moellmann's avatar
Gerd Moellmann committed
166
			esac
167
			shift;;
Gerd Moellmann's avatar
Gerd Moellmann committed
168 169 170
		esac
		case $logins in
		'') logins=$login;;
171
		?*) logins=$logins$nl$login;;
Gerd Moellmann's avatar
Gerd Moellmann committed
172
		esac
173 174 175 176
		case $loginFullnameMailaddrs in
		'') loginFullnameMailaddrs=$lfm;;
		?*) loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$lfm;;
		esac;;
Gerd Moellmann's avatar
Gerd Moellmann committed
177 178 179
	-r)
		case $rlog_options in
		'') rlog_options=${2?};;
180
		?*) rlog_options=$rlog_options$nl${2?};;
Gerd Moellmann's avatar
Gerd Moellmann committed
181 182 183 184 185 186 187 188 189 190 191 192 193
		esac
		shift;;
	-R)	recursive=t;;
	-t)	tabwidth=${2?}; shift;;
	-v)	revision=t;;
	--version)
		set $Id
		rcs2logVersion=$3
		echo >&2 "rcs2log (GNU Emacs) $rcs2logVersion$nl$Copyright"
		exit 0;;
	-*)	echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help"
		case $1 in
		--help) exit 0;;
194
		*) exit 1;;
Gerd Moellmann's avatar
Gerd Moellmann committed
195
		esac;;
196
	*)	break;;
Gerd Moellmann's avatar
Gerd Moellmann committed
197 198 199 200 201 202 203 204 205 206 207
	esac
	shift
done

month_data='
	m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
	m[3]="Apr"; m[4]="May"; m[5]="Jun"
	m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
	m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
'

Paul Eggert's avatar
Paul Eggert committed
208 209 210 211 212 213 214 215 216
if type mktemp >/dev/null 2>&1; then
	logdir=`mktemp -d`
else
	logdir=$TMPDIR/rcs2log$$
	(umask 077 && mkdir "$logdir")
fi || exit
case $logdir in
-*) logdir=./$logdir;;
esac
217
trap exit 1 2 13 15
Paul Eggert's avatar
Paul Eggert committed
218 219 220
trap "rm -fr \"$logdir\" 2>/dev/null" 0

llogout=$logdir/l
Gerd Moellmann's avatar
Gerd Moellmann committed
221

222 223
# If no rlog-format log file is given, generate one into $rlogfile.
case $rlogfile in
Gerd Moellmann's avatar
Gerd Moellmann committed
224
'')
225 226 227 228
	rlogfile=$logdir/r

	# If no rlog options are given,
	# log the revisions checked in since the first ChangeLog entry.
229 230 231
	# 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.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
	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.
Gerd Moellmann's avatar
Gerd Moellmann committed
260 261
	if test -s "$changelog"
	then
262 263 264
		extractTZ='
			/^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
				s//\1/; p; q
Gerd Moellmann's avatar
Gerd Moellmann committed
265
			}
266 267
			/^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
				s//UTC0/; p; q
Gerd Moellmann's avatar
Gerd Moellmann committed
268 269
			}
		'
270 271 272
		logTZ=`tail "$changelog" | sed -n "$extractTZ"`
		case $logTZ in
		?*) TZ=$logTZ; export TZ;;
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275
		esac
	fi

276 277 278 279 280 281 282 283 284
	# 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 <CVS/Repository` || exit
		test ! -f CVS/Root || CVSROOT=`cat <CVS/Root` || exit
285
		pository=
286
		case $CVSROOT in
287 288
		/* | :fork:* | :local:*) ;;
		*/*)
289
			# remote repository
290 291 292 293
			pository=`expr "X$CVSROOT" : '[^/]*\(.*\)'`;;
		esac
		case $pository in
		'')
294 295 296
			# local repository
			case $repository in
			/*) ;;
297 298 299 300 301 302
			*)
				repository=${CVSROOT?}/$repository
				case $repository in
				:fork:* | :local:*)
					repository=`expr "$repository" : ':[^:]*:\(.*\)'`;;
				esac;;
303 304 305 306 307 308 309
			esac
			if test ! -d "$repository"
			then
				echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
				exit 1
			fi
			pository=$repository;;
Gerd Moellmann's avatar
Gerd Moellmann committed
310 311
		esac

312 313 314 315 316 317 318 319 320 321
		# Ensure that $pository ends in exactly one slash.
		while :
		do
			case $pository in
			*//) pository=`expr "X$pository" : 'X\(.*\)/'`;;
			*/) break;;
			*) pository=$pository/; break;;
			esac
		done

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
		# 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 <CVS/Tag` || exit
				case $CVSTAG in
				T?*)
					rlog_options=-r`expr "$CVSTAG" : 'T\(.*\)'`;;
				*)
					echo >&2 "$0: invalid CVS/Tag"; exit 1;;
				esac
			fi;;
		esac
337 338 339 340 341 342 343 344 345 346
	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;;
Gerd Moellmann's avatar
Gerd Moellmann committed
347 348
	esac

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
	# 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;;
Gerd Moellmann's avatar
Gerd Moellmann committed
387
					esac
388 389 390 391 392
					case $files in
					'') files=$file;;
					?*) files=$files$nl$file;;
					esac
				done
Gerd Moellmann's avatar
Gerd Moellmann committed
393
				case $files in
394 395
				'') exit 0;;
				esac;;
Gerd Moellmann's avatar
Gerd Moellmann committed
396
			esac
397 398 399 400
			set x $files
			shift
			IFS=$oldIFS;;
		esac;;
Gerd Moellmann's avatar
Gerd Moellmann committed
401 402
	esac

403 404 405 406 407
	case $datearg in
	?*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogfile;;
	'') $rlog $rlog_options ${1+"$@"} >$rlogfile;;
	esac || exit;;
esac
Gerd Moellmann's avatar
Gerd Moellmann committed
408 409


Paul Eggert's avatar
Paul Eggert committed
410 411 412 413 414 415
# 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 2>/dev/null || SORT_K_OPTIONS='+2 -4r +4 +0'


Gerd Moellmann's avatar
Gerd Moellmann committed
416
# Get the full name of each author the logs mention, and set initialize_fullname
417
# to awk code that initializes the 'fullname' awk associative array.
Gerd Moellmann's avatar
Gerd Moellmann committed
418 419 420 421 422 423 424 425 426 427
# Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
# you have to fix the resulting output by hand.

initialize_fullname=
initialize_mailaddr=

case $loginFullnameMailaddrs in
?*)
	case $loginFullnameMailaddrs in
	*\"* | *\\*)
Paul Eggert's avatar
Paul Eggert committed
428
		sed 's/["\\]/\\&/g' >"$llogout" <<EOF || exit
Gerd Moellmann's avatar
Gerd Moellmann committed
429 430
$loginFullnameMailaddrs
EOF
Paul Eggert's avatar
Paul Eggert committed
431
		loginFullnameMailaddrs=`cat "$llogout"`;;
Gerd Moellmann's avatar
Gerd Moellmann committed
432 433 434 435 436 437
	esac

	oldIFS=$IFS
	IFS=$nl
	for loginFullnameMailaddr in $loginFullnameMailaddrs
	do
438
		IFS=$tab
Gerd Moellmann's avatar
Gerd Moellmann committed
439 440 441 442 443 444 445 446 447
		set x $loginFullnameMailaddr
		login=$2
		fullname=$3
		mailaddr=$4
		initialize_fullname="$initialize_fullname
			fullname[\"$login\"] = \"$fullname\""
		initialize_mailaddr="$initialize_mailaddr
			mailaddr[\"$login\"] = \"$mailaddr\""
	done
448
	IFS=$oldIFS;;
Gerd Moellmann's avatar
Gerd Moellmann committed
449 450
esac

451 452
case $logins in
?*)
Paul Eggert's avatar
Paul Eggert committed
453
	sort -u -o "$llogout" <<EOF
Gerd Moellmann's avatar
Gerd Moellmann committed
454 455
$logins
EOF
456 457 458
	;;
'')
	: ;;
Paul Eggert's avatar
Paul Eggert committed
459
esac >"$llogout" || exit
460

Gerd Moellmann's avatar
Gerd Moellmann committed
461
output_authors='/^date: / {
Paul Eggert's avatar
Paul Eggert committed
462 463 464 465 466 467
	cvsformat = $5 == "author:"
	if ($2 ~ /^[0-9]*[-\/][0-9][0-9][-\/][0-9][0-9]$/ && (cvsformat ? $3 ~ /^[0-9][0-9]:[0-9][0-9]:[0-9][0-9]/ && $4 ~ /^[-+][0-9:]*;$/ : $3 ~ /^[0-9][0-9]:[0-9][0-9]:[0-9][0-9][-+0-9:]*;$/)) {
		author = $(5 + cvsformat)
		if ($(4 + cvsformat) == "author:" && author ~ /^[^;]*;$/) {
			print substr(author, 1, length(author)-1)
		}
Gerd Moellmann's avatar
Gerd Moellmann committed
468 469 470
	}
}'
authors=`
Paul Eggert's avatar
Paul Eggert committed
471
	$AWK "$output_authors" <"$rlogfile" | sort -u | comm -23 - "$llogout"
Gerd Moellmann's avatar
Gerd Moellmann committed
472 473 474
`
case $authors in
?*)
Paul Eggert's avatar
Paul Eggert committed
475
	cat >"$llogout" <<EOF || exit
Gerd Moellmann's avatar
Gerd Moellmann committed
476 477 478
$authors
EOF
	initialize_author_script='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
Paul Eggert's avatar
Paul Eggert committed
479
	initialize_author=`sed -e "$initialize_author_script" <"$llogout"`
Gerd Moellmann's avatar
Gerd Moellmann committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
	awkscript='
		BEGIN {
			alphabet = "abcdefghijklmnopqrstuvwxyz"
			ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
			'"$initialize_author"'
		}
		{
			if (author[$1]) {
				fullname = $5
				if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
					# Remove the junk from fullnames like "0000-Admin(0000)".
					fullname = substr(fullname, index(fullname, "-") + 1)
					fullname = substr(fullname, 1, index(fullname, "(") - 1)
				}
				if (fullname ~ /,[^ ]/) {
					# Some sites put comma-separated junk after the fullname.
					# Remove it, but leave "Bill Gates, Jr" alone.
					fullname = substr(fullname, 1, index(fullname, ",") - 1)
				}
				abbr = index(fullname, "&")
				if (abbr) {
					a = substr($1, 1, 1)
					A = a
					i = index(alphabet, a)
					if (i) A = substr(ALPHABET, i, 1)
					fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
				}

				# Quote quotes and backslashes properly in full names.
				# Do not use gsub; traditional awk lacks it.
				quoted = ""
				rest = fullname
				for (;;) {
					p = index(rest, "\\")
					q = index(rest, "\"")
					if (p) {
						if (q && q<p) p = q
					} else {
						if (!q) break
						p = q
					}
					quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
					rest = substr(rest, p+1)
				}

				printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
				author[$1] = 0
			}
		}
	'

	initialize_fullname=`
		{
			(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"
543
	`$initialize_fullname;;
Gerd Moellmann's avatar
Gerd Moellmann committed
544 545 546 547 548
esac


# Function to print a single log line.
# We don't use awk functions, to stay compatible with old awk versions.
549 550
# 'Log' is the log message.
# 'files' contains the affected files.
Gerd Moellmann's avatar
Gerd Moellmann committed
551 552 553 554 555 556
printlogline='{

	# Following the GNU coding standards, rewrite
	#	* file: (function): comment
	# to
	#	* file (function): comment
557
	if (Log ~ /^\([^)]*\):[\t\n ]/) {
Gerd Moellmann's avatar
Gerd Moellmann committed
558
		i = index(Log, ")")
559 560 561 562 563 564
		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
Gerd Moellmann's avatar
Gerd Moellmann committed
565 566 567 568 569
		Log = substr(Log, i+3)
	}

	# If "label: comment" is too long, break the line after the ":".
	sep = " "
570 571
	i = index(Log, "\n")
	if ('"$length"' <= '"$indent"' + 1 + length(files) + i) sep = "\n" indent_string
Gerd Moellmann's avatar
Gerd Moellmann committed
572 573 574 575

	# Print the label.
	printf "%s*%s:", indent_string, files

576 577
	# Print each line of the log.
	while (i) {
Gerd Moellmann's avatar
Gerd Moellmann committed
578 579 580 581 582 583 584 585
		logline = substr(Log, 1, i-1)
		if (logline ~ /[^'"$tab"' ]/) {
			printf "%s%s\n", sep, logline
		} else {
			print ""
		}
		sep = indent_string
		Log = substr(Log, i+1)
586
		i = index(Log, "\n")
Gerd Moellmann's avatar
Gerd Moellmann committed
587 588 589
	}
}'

590
# Pattern to match the 'revision' line of rlog output.
Gerd Moellmann's avatar
Gerd Moellmann committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
rlog_revision_pattern='^revision [0-9]+\.[0-9]+(\.[0-9]+\.[0-9]+)*(['"$tab"' ]+locked by: [^'"$tab"' $,.0-9:;@]*[^'"$tab"' $,:;@][^'"$tab"' $,.0-9:;@]*;)?['"$tab"' ]*$'

case $hostname in
'')
	hostname=`(
		hostname || uname -n || uuname -l || cat /etc/whoami
	) 2>/dev/null` || {
		echo >&2 "$0: cannot deduce hostname"
		exit 1
	}

	case $hostname in
	*.*) ;;
	*)
		domainname=`(domainname) 2>/dev/null` &&
		case $domainname in
607 608 609
		*.*) hostname=$hostname.$domainname;;
		esac;;
	esac;;
Gerd Moellmann's avatar
Gerd Moellmann committed
610 611 612 613 614 615
esac


# Process the rlog output, generating ChangeLog style entries.

# First, reformat the rlog output so that each line contains one log entry.
616
# Transliterate \n to SOH so that multiline entries fit on a single line.
Gerd Moellmann's avatar
Gerd Moellmann committed
617
# Discard irrelevant rlog output.
618 619 620 621 622 623 624 625 626 627
$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)
Gerd Moellmann's avatar
Gerd Moellmann committed
628 629 630 631 632 633 634 635 636 637 638 639
			}
			if (filename ~ /,v$/) {
				filename = substr(filename, 1, length(filename) - 2)
			}
			if (filename ~ /(^|\/)Attic\/[^\/]*$/) {
				i = length(filename)
				while (substr(filename, i, 1) != "/") i--
				filename = substr(filename, 1, i - 6) substr(filename, i + 1)
			}
		}
		rev = "?"
	}
640
	/^Working file: / { if (repository == "") filename = substr($0, 15) }
Gerd Moellmann's avatar
Gerd Moellmann committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
	/'"$rlog_revision_pattern"'/, /^(-----------*|===========*)$/ {
		line = $0
		if (line ~ /'"$rlog_revision_pattern"'/) {
			rev = $2
			next
		}
		if (line ~ /^date: [0-9][- +\/0-9:]*;/) {
			date = $2
			if (date ~ /\//) {
				# This is a traditional RCS format date YYYY/MM/DD.
				# Replace "/"s with "-"s to get ISO format.
				newdate = ""
				while ((i = index(date, "/")) != 0) {
					newdate = newdate substr(date, 1, i-1) "-"
					date = substr(date, i+1)
				}
				date = newdate date
			}
Paul Eggert's avatar
Paul Eggert committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
			time = ""
			for (i = 3; i <= NF; i++) {
				time = time $i
				if (time ~ /;$/) {
					time = substr(time, 1, length(time) - 1)
					break
				}
			}
			i++
			if ($i == "author:") {
				author = $(i + 1)
				if (author ~ /;$/) {
					author = substr(author, 1, length(author) - 1)
				}
			} else {
				author = ""
			}
676
			printf "%s%s%s%s%s%s%s%s%s%s", filename, SOH, rev, SOH, date, SOH, time, SOH, author, SOH
Gerd Moellmann's avatar
Gerd Moellmann committed
677 678 679 680 681 682 683 684
			rev = "?"
			next
		}
		if (line ~ /^branches: /) { next }
		if (line ~ /^(-----------*|===========*)$/) { print ""; next }
		if (line == "Initial revision" || line ~ /^file .+ was initially added on branch .+\.$/) {
			line = "New file."
		}
685
		printf "%s%s", line, SOH
Gerd Moellmann's avatar
Gerd Moellmann committed
686
	}
687
' <"$rlogfile" |
Gerd Moellmann's avatar
Gerd Moellmann committed
688 689

# Now each line is of the form
690 691 692
# 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.
Gerd Moellmann's avatar
Gerd Moellmann committed
693 694 695
# 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).
Paul Eggert's avatar
Paul Eggert committed
696
sort -t"$SOH" $SORT_K_OPTIONS |
Gerd Moellmann's avatar
Gerd Moellmann committed
697 698

# Finally, reformat the sorted log entries.
699
$AWK -F"$SOH" '
Gerd Moellmann's avatar
Gerd Moellmann committed
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
	BEGIN {
		logTZ = "'"$logTZ"'"
		revision = "'"$revision"'"

		# Initialize the fullname and mailaddr associative arrays.
		'"$initialize_fullname"'
		'"$initialize_mailaddr"'

		# Initialize indent string.
		indent_string = ""
		i = '"$indent"'
		if (0 < '"$tabwidth"')
			for (;  '"$tabwidth"' <= i;  i -= '"$tabwidth"')
				indent_string = indent_string "\t"
		while (1 <= i--)
			indent_string = indent_string " "
	}

	{
719 720
		newlog = ""
		for (i = 6; i < NF; i++) newlog = newlog $i "\n"
Gerd Moellmann's avatar
Gerd Moellmann committed
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

		# Ignore log entries prefixed by "#".
		if (newlog ~ /^#/) { next }

		if (Log != newlog || date != $3 || author != $5) {

			# The previous log and this log differ.

			# Print the old log.
			if (date != "") '"$printlogline"'

			# Logs that begin with "{clumpname} " should be grouped together,
			# and the clumpname should be removed.
			# Extract the new clumpname from the log header,
			# and use it to decide whether to output a blank line.
			newclumpname = ""
			sep = "\n"
			if (date == "") sep = ""
			if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
				i = index(newlog, "}")
				newclumpname = substr(newlog, 1, i)
				while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
				newlog = substr(newlog, i+1)
744
				if (clumpname == newclumpname && date == $3 && author == $5) sep = ""
Gerd Moellmann's avatar
Gerd Moellmann committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
			}
			printf sep
			clumpname = newclumpname

			# Get ready for the next log.
			Log = newlog
			if (files != "")
				for (i in filesknown)
					filesknown[i] = 0
			files = ""
		}
		if (date != $3  ||  author != $5) {
			# The previous date+author and this date+author differ.
			# Print the new one.
			date = $3
			time = $4
			author = $5

			zone = ""
			if (logTZ && ((i = index(time, "-")) || (i = index(time, "+"))))
				zone = " " substr(time, i)

			# Print "date[ timezone]  fullname  <email address>".
			# Get fullname and email address from associative arrays;
			# default to author and author@hostname if not in arrays.
			if (fullname[author])
				auth = fullname[author]
			else
				auth = author
			printf "%s%s  %s  ", date, zone, auth
			if (mailaddr[author])
				printf "<%s>\n\n", mailaddr[author]
			else
				printf "<%s@%s>\n\n", author, "'"$hostname"'"
		}
		if (! filesknown[$1]) {
			filesknown[$1] = 1
			if (files == "") files = " " $1
			else files = files ", " $1
			if (revision && $2 != "?") files = files " " $2
		}
	}
	END {
		# Print the last log.
		if (date != "") {
			'"$printlogline"'
			printf "\n"
		}
	}
' &&


# Exit successfully.

Paul Eggert's avatar
Paul Eggert committed
799
exec rm -fr "$logdir"
Gerd Moellmann's avatar
Gerd Moellmann committed
800 801 802 803

# Local Variables:
# tab-width:4
# End: