* lisp/vc/vc.el (vc-log-search): Fix docstring (bug#36644).

* lisp/vc/vc-git.el (vc-git-log-search): Add docstring.

diff --git a/etc/NEWS b/etc/NEWS
index 08f0e654f7fd99f81c1e41a6ec15f32cff40f409..c1cc216659e6af3d753f427bfbb5339ca35dc502 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -703,8 +703,8 @@ buffers will delete the marked files (or if no files are marked, the
 file under point).  This command does not notify the VC backend, and
 is mostly useful for unregistered files.
 
-*** New command 'vc-log-search' asks for a pattern string, searches
-it in the revision log, and displays matched log entries in the
+*** New command 'vc-log-search' asks for a pattern, searches it
+in the revision log, and displays matched log entries in the
 log buffer.  For example, 'M-x vc-log-search RET bug#36644 RET'
 displays all entries whose log messages match the bug number.
 With a prefix argument asks for a command, so for example,

diff --git a/lisp/vc/vc-git.el b/lisp/vc/vc-git.el
index d4833d86ac462866df2c4b3644ec86e3524e99e8..9715aea1fdcf4f55fb278086deafa93822a68241 100644 (file)
--- a/lisp/vc/vc-git.el
+++ b/lisp/vc/vc-git.el
@@ -74,6 +74,9 @@
 ;; - steal-lock (file &optional revision)          NOT NEEDED
 ;; HISTORY FUNCTIONS
 ;; * print-log (files buffer &optional shortlog start-revision limit)   OK
+;; * log-outgoing (buffer remote-location)         OK
+;; * log-incoming (buffer remote-location)         OK
+;; - log-search (buffer pattern)                   OK
 ;; - log-view-mode ()                              OK
 ;; - show-log-entry (revision)                     OK
 ;; - comment-history (file)                        ??
@@ -1074,6 +1077,13 @@ If LIMIT is a revision string, use it as an end-revision."
                      remote-location))))
 
 (defun vc-git-log-search (buffer pattern)
+  "Search the log of changes for PATTERN and output results into BUFFER.
+
+PATTERN is a basic regular expression by default in Git.
+
+Display all entries that match log messages in long format.
+With a prefix argument, ask for a command to run that will output
+log entries."
   (let ((args `("log" "--no-color" "-i"
                 ,(format "--grep=%s" (or pattern "")))))
     (when current-prefix-arg

diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index a68beb5e50563accff3fc03745532c404cf12757..4cac15392892b652bf27e7c0dfe0e39ccfaed90d 100644 (file)
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -339,7 +339,7 @@
 ;;
 ;; - log-search (pattern)
 ;;
-;;   Search for string PATTERN in the revision log.
+;;   Search for PATTERN in the revision log.
 ;;
 ;; - log-view-mode ()
 ;;
@@ -2532,7 +2532,12 @@ When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
 
 ;;;###autoload
 (defun vc-log-search (pattern)
-  "Search a log of changes for PATTERN string.
+  "Search the log of changes for PATTERN.
+
+PATTERN is usually interpreted as a regular expression.  However, its
+exact semantics is up to the backend's log search command; some can
+only match fixed strings.
+
 Display all entries that match log messages in long format.
 With a prefix argument, ask for a command to run that will output
 log entries."