diff options
| author | Philipp Stephani | 2016-12-18 22:18:01 +0100 |
|---|---|---|
| committer | Philipp Stephani | 2016-12-23 19:28:40 +0100 |
| commit | f69bd7954f113719bb0e46e143231744c80bef34 (patch) | |
| tree | ecd9ab561abc18964671a0131ad9dd22f2911b13 /doc/misc | |
| parent | c04ac8a3191820d37e7858b7ca4e31cf04808cc3 (diff) | |
| download | emacs-f69bd7954f113719bb0e46e143231744c80bef34.tar.gz emacs-f69bd7954f113719bb0e46e143231744c80bef34.zip | |
Clarify usage of 'ediff-cleanup-hook' (Bug#24675)
* doc/misc/ediff.texi (Hooks): Clarify usage of 'ediff-cleanup-hook'
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ediff.texi | 11 |
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). | |||
| 1247 | @vindex ediff-cleanup-hook | 1247 | @vindex ediff-cleanup-hook |
| 1248 | This hook is run just before @code{ediff-quit-hook}. This is a good | 1248 | This hook is run just before @code{ediff-quit-hook}. This is a good |
| 1249 | place to do various cleanups, such as deleting the variant buffers. | 1249 | place to do various cleanups, such as deleting the variant buffers. |
| 1250 | Ediff provides a function, @code{ediff-janitor}, as one such possible | 1250 | Ediff provides a helper function, @code{ediff-janitor}, that you can |
| 1251 | hook, which you can add to @code{ediff-cleanup-hook} with | 1251 | invoke from a private hook function. For example: |
| 1252 | @code{add-hook}. | 1252 | |
| 1253 | @example | ||
| 1254 | (defun my-ediff-janitor () | ||
| 1255 | (ediff-janitor nil nil)) | ||
| 1256 | (add-hook 'ediff-cleanup-hook #'my-ediff-janitor) | ||
| 1257 | @end example | ||
| 1253 | 1258 | ||
| 1254 | @findex ediff-janitor | 1259 | @findex ediff-janitor |
| 1255 | This function kills buffers A, B, and, possibly, C, if these buffers aren't | 1260 | This function kills buffers A, B, and, possibly, C, if these buffers aren't |