From: Philipp Stephani <phst@google.com>
Date: Sun, 18 Dec 2016 21:18:01 +0000 (+0100)
Subject: Clarify usage of 'ediff-cleanup-hook' (Bug#24675)
X-Git-Tag: emacs-25.1.91~10
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f69bd7954f113719bb0e46e143231744c80bef34;p=emacs.git

Clarify usage of 'ediff-cleanup-hook' (Bug#24675)

* doc/misc/ediff.texi (Hooks): Clarify usage of 'ediff-cleanup-hook'
---

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