From: Glenn Morris <rgm@gnu.org>
Date: Thu, 9 Feb 2012 06:25:18 +0000 (-0800)
Subject: Small VC doc fixes
X-Git-Url: http://git.hcoop.net/bpt/emacs.git/commitdiff_plain/dab3703d9b97bade872fed780b849b7848828eaf

Small VC doc fixes

* lisp/vc/log-view.el (log-view-toggle-entry-display):
* lisp/vc/vc.el (vc-merge, vc-pull): Doc fixes.
* etc/NEWS: Condense a few VC entries.
---

diff --git a/etc/NEWS b/etc/NEWS
index f9ede68408..e3e7498761 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -859,21 +859,20 @@ controlling the degree of parallelism.
 
 +++
 *** Support for pulling on distributed version control systems.
-`C-x v +' (`vc-pull') runs a "pull" operation, if it is supported, to
-update the current branch and working tree.  A prefix argument means
-to prompt the user for specifics, e.g. a pull location.
+`C-x v +' (`vc-pull') runs a "pull" operation, if it is supported
+(currently with Bzr, Git, and Mercurial), to update the current branch
+and working tree.  A prefix argument means to prompt the user for
+specifics, e.g. a pull location.
 
-**** `vc-update' is now an alias for `vc-pull'.
-
-**** Currently supported by Bzr, Git, and Mercurial.
+---
+*** `vc-update' is now an alias for `vc-pull'.
 
 +++
 *** Support for merging on distributed version control systems.
-The vc-merge command now runs a "merge" operation, if it is supported,
-to merge changes from another branch into the current one.  It prompts
-for specifics, e.g. a merge source.
-
-**** Currently supported for Bzr, Git, and Mercurial.
+The vc-merge command now runs a "merge" operation, if it is supported
+(currently with Bzr, Git, and Mercurial), to merge changes from
+another branch into the current one.  It prompts for specifics, e.g. a
+merge source.
 
 +++
 *** New option `vc-revert-show-diff' controls whether `vc-revert'
@@ -882,14 +881,11 @@ shows a diff while querying the user.  It defaults to t.
 +++
 *** Log entries in some Log View buffers can be toggled to display a
 longer description by typing RET (log-view-toggle-entry-display).
+This is currently supported for Bzr, Git, and Mercurial (to support
+another backend, define a `log-view-expanded-log-entry-function').
 In the Log View buffers made by `C-x v L' (vc-print-root-log), you can
 use this to display the full log entry for the revision at point.
 
-**** Currently supported for Bzr, Git, and Mercurial.
-
-**** Packages using Log View mode can enable this functionality by
-binding `log-view-expanded-log-entry-function' to a suitable function.
-
 +++
 *** New command `vc-ediff' allows visual comparison of two revisions
 of a file similar to `vc-diff', but using ediff backend.
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 9ee16e1016..c1c7f74bf7 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2012-02-09  Glenn Morris  <rgm@gnu.org>
 
+	* vc/log-view.el (log-view-toggle-entry-display):
+	* vc/vc.el (vc-merge, vc-pull): Doc fixes.
+
 	* mail/emacsbug.el (report-emacs-bug-can-use-osx-open)
 	(report-emacs-bug-can-use-xdg-email):
 	(report-emacs-bug-insert-to-mailer): Doc fixes.
diff --git a/lisp/vc/log-view.el b/lisp/vc/log-view.el
index 849954f2cf..7512c9283e 100644
--- a/lisp/vc/log-view.el
+++ b/lisp/vc/log-view.el
@@ -376,6 +376,8 @@ log entries."
       marked-list)))
 
 (defun log-view-toggle-entry-display ()
+  "If possible, expand the current Log View entry.
+This calls `log-view-expanded-log-entry-function' to do the work."
   (interactive)
   ;; Don't do anything unless `log-view-expanded-log-entry-function'
   ;; is defined in this mode.
diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 19da410287..e1141cb392 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -1889,6 +1889,7 @@ The headers are reset to their non-expanded form."
 ;;;###autoload
 (defun vc-merge ()
   "Perform a version control merge operation.
+You must be visiting a version controlled file, or in a `vc-dir' buffer.
 On a distributed version control system, this runs a \"merge\"
 operation to incorporate changes from another branch onto the
 current branch, prompting for an argument list.
@@ -2366,6 +2367,7 @@ depending on the underlying version-control system."
 ;;;###autoload
 (defun vc-pull (&optional arg)
   "Update the current fileset or branch.
+You must be visiting a version controlled file, or in a `vc-dir' buffer.
 On a distributed version control system, this runs a \"pull\"
 operation to update the current branch, prompting for an argument
 list if required.  Optional prefix ARG forces a prompt.