procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source 
* doc/misc/ediff.texi (Hooks): Clarify usage of 'ediff-cleanup-hook'
This commit is contained in:
Philipp Stephani 2016-12-18 22:18:01 +01:00
parent c04ac8a319
commit f69bd7954f
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/misc/ediff.texi
View file

@ -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