From unknown Sat Aug 09 20:50:11 2025 X-Loop: help-debbugs@gnu.org Subject: bug#24675: 26.0.50; Misleading suggestion in Ediff Info manual Resent-From: Philipp Stephani
Philipp Stephani wrote:
> The Ediff Info manual, in section 7.1 "Hooks", says:
>
> 'ediff-cleanup-hook'
>=C2=A0 =C2=A0 =C2=A0 This hook is run just before 'ediff-quit-hook&= #39;.=C2=A0 This is a good
>=C2=A0 =C2=A0 =C2=A0 place to do various cleanups, such as deleting the= variant buffers.
>=C2=A0 =C2=A0 =C2=A0 Ediff provides a function, 'ediff-janitor'= , as one such possible
>=C2=A0 =C2=A0 =C2=A0 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.=C2=A0 The manual should e.g. state that a lambda w= rapping
> ediff-janitor can be added to ediff-cleanup-hook, but not ediff-janito= r
> 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?
Philipp Steph= ani wrote:
> The Ediff Info manual, in section 7.1 "Hooks", says:
>
> 'ediff-cleanup-hook'
>=C2=A0 =C2=A0 =C2=A0 This hook is run just before 'ediff-quit-hook&= #39;.=C2=A0 This is a good
>=C2=A0 =C2=A0 =C2=A0 place to do various cleanups, such as deleting the= variant buffers.
>=C2=A0 =C2=A0 =C2=A0 Ediff provides a function, 'ediff-janitor'= , as one such possible
>=C2=A0 =C2=A0 =C2=A0 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.=C2=A0 The manual should e.g. state that a lambda w= rapping
> ediff-janitor can be added to ediff-cleanup-hook, but not ediff-janito= r
> 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?