[Emacs-diffs] /srv/bzr/emacs/trunk r101691: Fix documentation of VC status indicator in mode line.

[Eli Zaretskii]

------------------------------------------------------------
revno: 101691
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Thu 2010-09-30 14:44:25 +0200
message:
  Fix documentation of VC status indicator in mode line.
  
   lisp/vc/vc-hooks.el (vc-default-mode-line-string): Doc fix.
   doc/emacs/maintaining.texi (VC Mode Line): Mention all the possible VC
   status indicator characters.
modified:
  doc/emacs/ChangeLog
  doc/emacs/maintaining.texi
  lisp/ChangeLog
  lisp/vc/vc-hooks.el

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2010-09-29 04:25:59 +0000
+++ b/doc/emacs/ChangeLog       2010-09-30 12:44:25 +0000
@@ -1,3 +1,8 @@
+2010-09-30  Eli Zaretskii  <address@hidden>
+
+       * maintaining.texi (VC Mode Line): Mention all the possible VC status
+       indicator characters.
+
 2010-09-29  Glenn Morris  <address@hidden>
 
        * Makefile.in (top_srcdir): Remove unused variable.

=== modified file 'doc/emacs/maintaining.texi'
--- a/doc/emacs/maintaining.texi        2010-06-23 02:46:43 +0000
+++ b/doc/emacs/maintaining.texi        2010-09-30 12:44:25 +0000
@@ -362,10 +362,16 @@
 
 @node VC Mode Line
 @subsection Version Control and the Mode Line
address@hidden VC, mode line indicator
 
   When you visit a file that is under version control, Emacs indicates
-this on the mode line.  For example, @samp{RCS-1.3} says that RCS is
-used for that file, and the current version is 1.3.
+this on the mode line.  For example, @samp{RCS-1.3} says that the RCS
+back end is used for that file, and the current version of the file is
+1.3.
+
+  The first part of the VC mode-line indicator is the name of the back
+end: @samp{RCS}, @samp{CVS}, @samp{Bzr}, etc.  The back-end name is
+followed by a single character and the version of the file.
 
   The character between the back-end name and the revision ID
 indicates the version control status of the file.  @samp{-} means that
@@ -373,6 +379,12 @@
 locking is not in use).  @samp{:} indicates that the file is locked, or
 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}.
address@hidden@@} means that the file was locally added, but not yet committed
+to the master repository.  @samp{!} indicates that the file contains
+conflicts as result of a recent merge operation (@pxref{Merging}), or
+that the file was removed from the version control.  Finally, @samp{?}
+means that the file is under version control, but is missing from the
+working tree.
 
   On a graphical display, you can move the mouse over this mode line
 indicator to pop up a ``tool-tip'', which displays a more verbose

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2010-09-30 02:53:26 +0000
+++ b/lisp/ChangeLog    2010-09-30 12:44:25 +0000
@@ -1,3 +1,7 @@
+2010-09-30  Eli Zaretskii  <address@hidden>
+
+       * vc/vc-hooks.el (vc-default-mode-line-string): Doc fix.
+
 2010-09-30  Juanma Barranquero  <address@hidden>
 
        * server.el (server-start): Don't write pid to the authentication file.

=== modified file 'lisp/vc/vc-hooks.el'
--- a/lisp/vc/vc-hooks.el       2010-08-29 16:17:13 +0000
+++ b/lisp/vc/vc-hooks.el       2010-09-30 12:44:25 +0000
@@ -815,6 +815,9 @@
   \"BACKEND-REV\"        if the file is up-to-date
   \"BACKEND:REV\"        if the file is edited (or locked by the calling user)
   \"BACKEND:LOCKER:REV\" if the file is locked by somebody else
+  \"address@hidden"        if the file was locally added
+  \"BACKEND!REV\"        if the file contains conflicts or was removed
+  \"BACKEND?REV\"        if the file is under VC, but is missing
 
 This function assumes that the file is registered."
   (let* ((backend-name (symbol-name backend))