comparison man/maintaining.texi @ 61466:0d13c2e5baa9

(Change Log): Correct the description of the example.
author Richard M. Stallman <rms@gnu.org>
date Mon, 11 Apr 2005 16:40:42 +0000
parents 710c5be02d52
children 0659ac37d53c 146c086df160
comparison
equal deleted inserted replaced
61465:9cc4be7413fb 61466:0d13c2e5baa9
56 date, your name, and your email address (taken from the variable 56 date, your name, and your email address (taken from the variable
57 @code{add-log-mailing-address}). Aside from these header lines, every 57 @code{add-log-mailing-address}). Aside from these header lines, every
58 line in the change log starts with a space or a tab. The bulk of the 58 line in the change log starts with a space or a tab. The bulk of the
59 entry consists of @dfn{items}, each of which starts with a line starting 59 entry consists of @dfn{items}, each of which starts with a line starting
60 with whitespace and a star. Here are two entries, both dated in May 60 with whitespace and a star. Here are two entries, both dated in May
61 1993, each with two items: 61 1993, with two items and one item respectively.
62 62
63 @iftex 63 @iftex
64 @medbreak 64 @medbreak
65 @end iftex 65 @end iftex
66 @smallexample 66 @smallexample
77 * vc.el (minor-mode-map-alist): Don't use it if it's void. 77 * vc.el (minor-mode-map-alist): Don't use it if it's void.
78 (vc-cancel-version): Doc fix. 78 (vc-cancel-version): Doc fix.
79 @end smallexample 79 @end smallexample
80 80
81 One entry can describe several changes; each change should have its 81 One entry can describe several changes; each change should have its
82 own item. Normally there should be a blank line between items. When 82 own item, or its own line in an item. Normally there should be a
83 items are related (parts of the same change, in different places), group 83 blank line between items. When items are related (parts of the same
84 them by leaving no blank line between them. The second entry above 84 change, in different places), group them by leaving no blank line
85 contains two items grouped in this way. 85 between them.
86 86
87 @kbd{C-x 4 a} visits the change log file and creates a new entry 87 @kbd{C-x 4 a} visits the change log file and creates a new entry
88 unless the most recent entry is for today's date and your name. It 88 unless the most recent entry is for today's date and your name. It
89 also creates a new item for the current file. For many languages, it 89 also creates a new item for the current file. For many languages, it
90 can even guess the name of the function or other object that was 90 can even guess the name of the function or other object that was
91 changed. 91 changed.
92 92
93 @vindex add-log-keep-changes-together 93 @vindex add-log-keep-changes-together
94 When the variable @code{add-log-keep-changes-together} is 94 When the variable @code{add-log-keep-changes-together} is
95 non-@code{nil}, @kbd{C-x 4 a} adds to any existing entry for the file 95 non-@code{nil}, @kbd{C-x 4 a} adds to any existing item for the file
96 rather than starting a new entry. 96 rather than starting a new item.
97 97
98 @vindex change-log-version-info-enabled 98 @vindex change-log-version-info-enabled
99 @vindex change-log-version-number-regexp-list 99 @vindex change-log-version-number-regexp-list
100 @cindex file version in change log entries 100 @cindex file version in change log entries
101 If the value of the variable @code{change-log-version-info-enabled} 101 If the value of the variable @code{change-log-version-info-enabled}