aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii <[email protected]>2010-09-30 14:44:25 +0200
committerEli Zaretskii <[email protected]>2010-09-30 14:44:25 +0200
commitcad90f3b7ad1fafdb09d1bcd3fe4908f94cb3943 (patch)
tree8f26c612d9ad2ecde3430812dcc2ab8f7f360bd6
parent743595bc3405fc3d063a5089ea54fcd33b0812ad (diff)
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.
-rw-r--r--doc/emacs/ChangeLog5
-rw-r--r--doc/emacs/maintaining.texi16
-rw-r--r--lisp/ChangeLog4
-rw-r--r--lisp/vc/vc-hooks.el3
4 files changed, 26 insertions, 2 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index 79a2b0ec2f..cba54de80b 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,8 @@
+2010-09-30 Eli Zaretskii <[email protected]>
+
+ * maintaining.texi (VC Mode Line): Mention all the possible VC status
+ indicator characters.
+
2010-09-29 Glenn Morris <[email protected]>
* Makefile.in (top_srcdir): Remove unused variable.
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index f5a93ec60e..b407f5b9c9 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -362,10 +362,16 @@ change, and later use the @kbd{C-x v a} command to copy it to
@node VC Mode Line
@subsection Version Control and the Mode Line
+@cindex 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 @@ the work file is not locked (if locking is in use), or not modified (if
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}.
+@samp{@@} 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
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index a5d171744e..b23262bc36 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2010-09-30 Eli Zaretskii <[email protected]>
+
+ * vc/vc-hooks.el (vc-default-mode-line-string): Doc fix.
+
2010-09-30 Juanma Barranquero <[email protected]>
* server.el (server-start): Don't write pid to the authentication file.
diff --git a/lisp/vc/vc-hooks.el b/lisp/vc/vc-hooks.el
index 91e9b8e3cd..5007231d96 100644
--- a/lisp/vc/vc-hooks.el
+++ b/lisp/vc/vc-hooks.el
@@ -815,6 +815,9 @@ Format:
\"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
+ \"BACKEND@REV\" 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))