From: David Engster <dengste@eml.cc>
Date: Tue, 7 Jan 2014 20:40:44 +0000 (+0100)
Subject: Add new hook to augment help buffers.
X-Git-Tag: emacs-24.3.90~173^2^2~42^2~45^2~387^2~14^2~1
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=abb82152dcd743c284bcd7b4ecb31d20543ec735;p=emacs.git

Add new hook to augment help buffers.

* help-fns.el (help-fns-describe-function-functions): New variable to
call functions for augmenting help buffers.
(describe-function-1): Remove explicit calls to
`help-fns--compiler-macro', `help-fns--parent-mode' and
`help-fns--obsolete'.  Put them in above new variable instead.  Call
all of them through `run-hook-with-args'.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index add146fd2b1..9f5e87f5e1e 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,12 @@
+2014-01-07  David Engster  <deng@randomsample.de>
+
+	* help-fns.el (help-fns-describe-function-functions): New
+	variable to call functions for augmenting help buffers.
+	(describe-function-1): Remove explicit calls to
+	`help-fns--compiler-macro', `help-fns--parent-mode' and
+	`help-fns--obsolete'.  Put them in above new variable instead.
+	Call all of them through `run-hook-with-args'.
+
 2014-01-07  Martin Rudalics  <rudalics@gmx.at>
 
 	* window.el (balance-windows-2): While rounding don't give a
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 7b9e1783bad..2252c700fea 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -32,6 +32,12 @@
 
 ;;; Code:
 
+(defvar help-fns-describe-function-functions nil
+  "List of functions to run in help buffer in `describe-function'.
+Those functions will be run after the header line and argument
+list was inserted, and before the documentation will be inserted.
+The functions will receive the function name as argument.")
+
 ;; Functions
 
 ;;;###autoload
@@ -649,14 +655,15 @@ FILE is the file where FUNCTION was probably defined."
         (help-fns--key-bindings function)
         (with-current-buffer standard-output
           (setq doc (help-fns--signature function doc real-def real-function))
-
-          (help-fns--compiler-macro function)
-          (help-fns--parent-mode function)
-          (help-fns--obsolete function)
-
+	  (run-hook-with-args 'help-fns-describe-function-functions function)
           (insert "\n"
                   (or doc "Not documented.")))))))
 
+;; Add defaults to `help-fns-describe-function-functions'.
+(add-hook 'help-fns-describe-function-functions 'help-fns--obsolete)
+(add-hook 'help-fns-describe-function-functions 'help-fns--parent-mode)
+(add-hook 'help-fns-describe-function-functions 'help-fns--compiler-macro)
+
 
 ;; Variables