Re: man/files.texi

[Luc Teirlinck]

Eli Zaretskii wrote:

   How about moving the entire documentation of auto-revert-check-vc-info
   to one of the sections that document VC?

I indeed believe that it belongs in `(emacs)VC Mode Line'.  I also
made some further changes to the text.  I propose the following patch,
which I can install, if desired:

===File ~/man-files.texi-diff===============================
diff -c /home/teirllm/emacscvsdir/emacs/man/files.texi 
/home/teirllm/files-mar29.texi
*** /home/teirllm/emacscvsdir/emacs/man/files.texi      Tue Mar 29 20:31:35 2005
--- /home/teirllm/files-mar29.texi      Tue Mar 29 20:17:05 2005
***************
*** 940,954 ****
  for a changed file.  Since checking a remote file is too slow, these
  modes do not check or revert remote files.
  
- @vindex auto-revert-check-vc-info
-   Whenever Auto Revert mode reverts the buffer, it updates the version
- control information, such as the version control number displayed in
- the mode line.  However, this information may not be properly updated
- if the version control state changes outside of Emacs---for example,
- if a new version is checked in from outside the current Emacs session.
- If you set @code{auto-revert-check-vc-info} to @code{t}, Auto Revert
- mode will update the version control status information periodically.
- 
  @node Auto Save
  @section Auto-Saving: Protection Against Disasters
  @cindex Auto Save mode
--- 940,945 ----
***************
*** 1375,1380 ****
--- 1366,1383 ----
  that it is modified.  If the file is locked by some other user (for
  instance, @samp{jim}), that is displayed as @samp{RCS:jim:1.3}.
  
+ @vindex auto-revert-check-vc-info
+   When Auto Revert mode (@pxref{Reverting}) reverts a buffer that is
+ under version control, it updates the version control information in
+ the mode line.  However, Auto Revert mode may not properly update this
+ information if you change the version control status without changes
+ to the work file, from outside the current Emacs session.  If you set
+ @code{auto-revert-check-vc-info} to @code{t}, Auto Revert mode updates
+ the version control status information every
+ @code{auto-revert-interval} seconds, even if the work file itself is
+ unchanged.  The resulting CPU usage depends on the version control
+ system, but is usually not excessive.
+ 
  @node Basic VC Editing
  @subsection Basic Editing under Version Control
  

Diff finished.  Tue Mar 29 20:32:03 2005
============================================================