comparison lib-src/rcs2log @ 54965:860258597b78

* rcs2log (Help): Clarify wording of the usage message.
author Paul Eggert <eggert@twinsun.com>
date Sun, 18 Apr 2004 06:02:16 +0000
parents 8f3f4ab62a69
children 23a17af379b1 8f4a3987f4a8 4c90ffeb71c5
comparison
equal deleted inserted replaced
54964:4732f3096a88 54965:860258597b78
1 #! /bin/sh 1 #! /bin/sh
2 2
3 # RCS to ChangeLog generator 3 # RCS to ChangeLog generator
4 4
5 # Generate a change log prefix from RCS files (perhaps in the CVS repository) 5 Help='
6 # and the ChangeLog (if any). 6 Generate ChangeLog entries from RCS files (perhaps in a CVS repository)
7 # Output the new prefix to standard output. 7 and the ChangeLog file (if any). An RCS file typically has a name
8 # You can edit this prefix by hand, and then prepend it to ChangeLog. 8 ending in ",v", and represents the entire history of a file that is
9 9 under revision control. The ChangeLog file logs entries for changes,
10 # Ignore log entries that start with `#'. 10 in reverse chronological order.
11 # Clump together log entries that start with `{topic} ', 11
12 # where `topic' contains neither white space nor `}'. 12 Generate entries for changes entered into RCS (or CVS) more recently
13 13 than the newest existing entry in the ChangeLog file. You can then
14 Help='The default FILEs are the files registered under the working directory. 14 edit these entries by hand, and prepend them to the ChangeLog file.
15
16 Output the resulting ChangeLog entries to standard output.
17 Each entry looks something like this:
18
19 2004-04-17 Paul Eggert <eggert@gnu.org>
20
21 * rcs2log (Help): Clarify wording of the usage message.
22 Problem reported by Alan Mackenzie in
23 <http://mail.gnu.org/archive/html/bug-gnu-emacs/2004-04/msg00188.html>.
24
25 ChangeLog entries contain the current date, full name, email address
26 including hostname, the name of the affected file, and commentary.
27 RCS and CVS logs lack full names and email addresses, so they are
28 inferred from login names using a heuristic that can be overridden
29 via the -u option.
30
31 Ignore log entries that start with "#".
32 Clump together log entries that start with "{topic} ",
33 where "topic" contains neither white space nor "}".
34
35 If no FILE is specified, use all files under the working directory
36 that are maintained under version control.
37
15 Options: 38 Options:
16 39
17 -c CHANGELOG Output a change log prefix to CHANGELOG (default ChangeLog). 40 -c FILE Output ChangeLog entries for FILE (default ChangeLog).
18 -h HOSTNAME Use HOSTNAME in change log entries (default current host). 41 -h HOSTNAME Use HOSTNAME in change log entries (default current host).
19 -i INDENT Indent change log lines by INDENT spaces (default 8). 42 -i INDENT Indent change log lines by INDENT spaces (default 8).
20 -l LENGTH Try to limit log lines to LENGTH characters (default 79). 43 -l LENGTH Try to limit log lines to LENGTH characters (default 79).
21 -L FILE Use rlog-format FILE for source of logs. 44 -L FILE Use FILE (same format as "rlog") for source of logs.
22 -R If no FILEs are given and RCS is used, recurse through working directory. 45 -R If no FILEs are given and RCS is used, recurse through working directory.
23 -r OPTION Pass OPTION to subsidiary log command. 46 -r OPTION Pass OPTION to subsidiary command (either "rlog" or "cvs -q log").
24 -t TABWIDTH Tab stops are every TABWIDTH characters (default 8). 47 -t TABWIDTH Tab stops are every TABWIDTH characters (default 8).
25 -u "LOGIN<tab>FULLNAME<tab>MAILADDR" Assume LOGIN has FULLNAME and MAILADDR. 48 -u "LOGIN<tab>FULLNAME<tab>EMAILADDR" LOGIN has FULLNAME and EMAILADDR.
26 -v Append RCS revision to file names in log lines. 49 -v Append RCS revision to file names in log lines.
27 --help Output help. 50 --help Output help.
28 --version Output version number. 51 --version Output version number.
29 52
30 Report bugs to <bug-gnu-emacs@gnu.org>.' 53 Report bugs to <bug-gnu-emacs@gnu.org>.'
31 54
32 Id='$Id: rcs2log,v 1.52 2003/12/27 08:18:08 uid65632 Exp $' 55 Id='$Id: rcs2log,v 1.53 2004/02/15 07:41:58 uid65632 Exp $'
33 56
34 # Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2002, 2003, 57 # Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2002, 2003,
35 # 2004 Free Software Foundation, Inc. 58 # 2004 Free Software Foundation, Inc.
36 59
37 # This program is free software; you can redistribute it and/or modify 60 # This program is free software; you can redistribute it and/or modify