Re: log-view documentation

["Aaron S. Hawley" <Aaron.Hawley@uvm.edu>]

[-- Attachment #1: Type: TEXT/PLAIN, Size: 1751 bytes --]

On Wed, 23 Nov 2005, Richard M. Stallman wrote:

> Our style is to use @table @kbd for this.
> Please look at other such lists in the manual
> to see the proper style, especially for index entries
> and for giving the names of the commands.

That makes sense.  I was confused by the commands marked up as a list in
the "Old Versions" node -- no longer!

I've modified the patch to use the Texinfo table style.  I adopted (read:
copied)  and incorporated respectively the wording changes you've proposed
for documenting `vc-annotate'.  I also added some more cross references.
The patch is attached, but here's the table.

 @table @kbd

 @item p
 Move to the previous revision of the file.  A numeric prefix argument
 is a repeat count, so @kbd{C-u 10 p} would move backward 10 revisions.

 @item n
 Move to the next revision of the file.  A numeric prefix argument
 is a repeat count.

 @item f
 Visit the revision indicated at the current line, like typing @kbd{C-x
 v ~} and specifying the revision (@pxref{Old Versions}).

 @item d
 Display the diff (@pxref{Comparing Files}) between the revision
 indicated at the current line and the revision before it.  This is
 useful to see what actually changed when the revision indicated on the
 current line was committed.

 @item P
 Move to the log of the previous file when there are multiple files in
 the log buffer (@pxref{VC Dired Mode}).  Otherwise, it moves to the
 beginning of the log.  It also takes a numeric prefix argument as a
 repeat count, so @kbd{C-u 10 P} would move backward 10 files.

 @item N
 Move to the log of the next file when there are logs for multiple
 files in the log buffer (@pxref{VC Dired Mode}).  It also takes a
 numeric prefix argument as a repeat count.

 @end table

[-- Attachment #2: log-view patch --]
[-- Type: TEXT/PLAIN, Size: 1894 bytes --]

--- files.texi	18 Nov 2005 13:54:05 -0500	1.122
+++ files.texi	25 Nov 2005 19:22:12 -0500	
@@ -1791,7 +1791,45 @@
   To view the detailed version control status and history of a file,
 type @kbd{C-x v l} (@code{vc-print-log}).  It displays the history of
 changes to the current file, including the text of the log entries.  The
-output appears in a separate window.
+output appears in a separate window.  The point is centered at the
+revision of the file that was currently visited.
+
+From the change log buffer, the following keys can be used to move
+between the logs of files and revisions, to view past revisions, and
+to view diffs:
+
+@table @kbd
+
+@item p
+Move to the previous revision of the file.  A numeric prefix argument
+is a repeat count, so @kbd{C-u 10 p} would move backward 10 revisions.
+
+@item n
+Move to the next revision of the file.  A numeric prefix argument
+is a repeat count.
+
+@item f
+Visit the revision indicated at the current line, like typing @kbd{C-x
+v ~} and specifying the revision (@pxref{Old Versions}).
+
+@item d
+Display the diff (@pxref{Comparing Files}) between the revision
+indicated at the current line and the revision before it.  This is
+useful to see what actually changed when the revision indicated on the
+current line was committed.
+
+@item P
+Move to the log of the previous file when there are multiple files in
+the log buffer (@pxref{VC Dired Mode}).  Otherwise, it moves to the
+beginning of the log.  It also takes a numeric prefix argument as a
+repeat count, so @kbd{C-u 10 P} would move backward 10 files.
+
+@item N
+Move to the log of the next file when there are logs for multiple
+files in the log buffer (@pxref{VC Dired Mode}).  It also takes a
+numeric prefix argument as a repeat count.
+
+@end table
 
 @node VC Undo
 @subsubsection Undoing Version Control Actions

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel