summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Stephani <phst@google.com>2016-12-18 22:18:01 +0100
committerPhilipp Stephani <phst@google.com>2016-12-23 19:28:40 +0100
commitf69bd7954f113719bb0e46e143231744c80bef34 (patch)
treeecd9ab561abc18964671a0131ad9dd22f2911b13
parentc04ac8a3191820d37e7858b7ca4e31cf04808cc3 (diff)
downloademacs-f69bd7954f113719bb0e46e143231744c80bef34.tar.gz
Clarify usage of 'ediff-cleanup-hook' (Bug#24675)
* doc/misc/ediff.texi (Hooks): Clarify usage of 'ediff-cleanup-hook'
-rw-r--r--doc/misc/ediff.texi11
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi
index 376aaeea46e..896a6041e86 100644
--- a/doc/misc/ediff.texi
+++ b/doc/misc/ediff.texi
@@ -1247,9 +1247,14 @@ merged (see @code{ediff-cleanup-hook}, below).
@vindex ediff-cleanup-hook
This hook is run just before @code{ediff-quit-hook}. This is a good
place to do various cleanups, such as deleting the variant buffers.
-Ediff provides a function, @code{ediff-janitor}, as one such possible
-hook, which you can add to @code{ediff-cleanup-hook} with
-@code{add-hook}.
+Ediff provides a helper function, @code{ediff-janitor}, that you can
+invoke from a private hook function. For example:
+
+@example
+(defun my-ediff-janitor ()
+ (ediff-janitor nil nil))
+(add-hook 'ediff-cleanup-hook #'my-ediff-janitor)
+@end example
@findex ediff-janitor
This function kills buffers A, B, and, possibly, C, if these buffers aren't