From: Philipp Stephani <p.stephani2@gmail.com>
To: Glenn Morris <rgm@gnu.org>
Cc: 24675@debbugs.gnu.org
Subject: bug#24675: 26.0.50; Misleading suggestion in Ediff Info manual
Date: Sun, 18 Dec 2016 21:25:41 +0000 [thread overview]
Message-ID: <CAArVCkQTer_5fET7ZUc-YVYg+yNQLi1ow2TvPXXZ4jpJUPvo9A@mail.gmail.com> (raw)
In-Reply-To: <tcinqn3dvv.fsf@fencepost.gnu.org>
[-- Attachment #1.1: Type: text/plain, Size: 1292 bytes --]
Glenn Morris <rgm@gnu.org> schrieb am Di., 13. Dez. 2016 um 19:03 Uhr:
> Philipp Stephani wrote:
>
> > The Ediff Info manual, in section 7.1 "Hooks", says:
> >
> > 'ediff-cleanup-hook'
> > This hook is run just before 'ediff-quit-hook'. This is a good
> > place to do various cleanups, such as deleting the variant buffers.
> > Ediff provides a function, 'ediff-janitor', as one such possible
> > hook, which you can add to 'ediff-cleanup-hook' with 'add-hook'.
> >
> > However, ediff-cleanup-hook is a normal hook, and ediff-janitor is a
> > function taking two required arguments, so it cannot be added to
> > ediff-cleanup-hook. The manual should e.g. state that a lambda wrapping
> > ediff-janitor can be added to ediff-cleanup-hook, but not ediff-janitor
> > itself.
>
> It seems the doc hasn't been updated in the past 14 years.
> Before 50a07e1, there was a single optional argument.
> You might be one of the few users of this functionality, so maybe you
> would like to fix the doc yourself?
I don't use it myself, but I got a report from a colleague who interpreted
the manual such that you could add ediff-janitor directly to the hook with
add-hook. I've attached a patch to clarify this. I'll push it to emacs-25
in a few days until there are complaints.
[-- Attachment #1.2: Type: text/html, Size: 2075 bytes --]
[-- Attachment #2: 0001-Clarify-usage-of-ediff-cleanup-hook-Bug-24675.txt --]
[-- Type: text/plain, Size: 1229 bytes --]
From 28556ab1879d54534363f5cb4cc9678f014efcc5 Mon Sep 17 00:00:00 2001
From: Philipp Stephani <phst@google.com>
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
next prev parent reply other threads:[~2016-12-18 21:25 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-12 15:54 bug#24675: 26.0.50; Misleading suggestion in Ediff Info manual Philipp Stephani
2016-12-13 18:03 ` Glenn Morris
2016-12-18 21:25 ` Philipp Stephani [this message]
2016-12-23 18:30 ` Philipp Stephani
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAArVCkQTer_5fET7ZUc-YVYg+yNQLi1ow2TvPXXZ4jpJUPvo9A@mail.gmail.com \
--to=p.stephani2@gmail.com \
--cc=24675@debbugs.gnu.org \
--cc=rgm@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.