[elpa] master 8f30437: Document change-revision transformer function; make a defcustom

[Michael Heerdegen]

branch: master
commit 8f304379ef8e0c1941e40925d11d09eb76bed39c
Author: Michael Heerdegen <address@hidden>
Commit: Michael Heerdegen <address@hidden>

    Document change-revision transformer function; make a defcustom
---
 packages/el-search/el-search-x.el |   20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/packages/el-search/el-search-x.el 
b/packages/el-search/el-search-x.el
index 96baeee..d41261d 100644
--- a/packages/el-search/el-search-x.el
+++ b/packages/el-search/el-search-x.el
@@ -156,7 +156,15 @@ could use this pattern:
 (defvar-local el-search--cached-changes nil)
 
 
-(defvar el-search-change-revision-transformer-function #'identity)
+(defcustom el-search-change-revision-transformer-function nil
+  "Transformer function for the REVISION argument of `change' and `changed'.
+
+When specified, this function is called on the REVISION argument
+of `change' and `changed' before passing it to git.  The default
+value is nil."
+  :group 'el-search
+  :type '(choice (const :tag "No transformer" nil)
+                 (function :tag "User specified function")))
 
 (defun el-search--changes-from-diff-hl (revision)
   "Return a list of changed regions (as conses of positions) since REVISION.
@@ -174,7 +182,7 @@ Use variable `el-search--cached-changes' for caching."
       (widen)
       (save-excursion
         (let ((diff-hl-reference-revision
-               (funcall el-search-change-revision-transformer-function 
revision))
+               (funcall (or el-search-change-revision-transformer-function 
#'identity) revision))
               (current-line-nbr 1) change-beg)
           (goto-char 1)
           (cdr (setq el-search--cached-changes
@@ -224,14 +232,18 @@ Use variable `el-search--cached-changes' for caching."
   "Matches the object if its text is part of a file change.
 
 Requires library \"diff-hl\".  REVISION defaults to the file's
-repository's HEAD commit."
+repository's HEAD commit and is a git revision string.  Customize
+`el-search-change-revision-transformer-function' to modify how
+REVISION is interpreted."
   `(guard (el-search--change-p (point) ,(or revision "HEAD"))))
 
 (el-search-defpattern changed (&optional revision)
   "Matches the object if its text contains a file change.
 
 Requires library \"diff-hl\".  REVISION defaults to the file's
-repository's HEAD commit."
+repository's HEAD commit and is a git revision string.  Customize
+`el-search-change-revision-transformer-function' to modify how
+REVISION is interpreted."
   `(guard (el-search--changed-p (point) ,(or revision "HEAD"))))