From 28556ab1879d54534363f5cb4cc9678f014efcc5 Mon Sep 17 00:00:00 2001 From: Philipp Stephani Date: Sun, 18 Dec 2016 22:18:01 +0100 Subject: [PATCH] Clarify usage of 'ediff-cleanup-hook' (Bug#24675) * doc/misc/ediff.texi (Hooks): Clarify usage of 'ediff-cleanup-hook' --- doc/misc/ediff.texi | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi index 376aaee..896a604 100644 --- a/doc/misc/ediff.texi +++ b/doc/misc/ediff.texi @@ -1247,9 +1247,14 @@ Hooks @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 -- 2.10.2