GNU bug report logs - #21728
25.0.50; [patch] mention focus-{in,out}-hook in manual

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 21728 in the body.
You can then email your comments to 21728 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Aaron Ecay <aaronecay <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.0.50; [patch] mention focus-{in,out}-hook in manual
Date: Wed, 21 Oct 2015 19:48:06 +0100

[Message part 1 (text/plain, inline)]

The emacs lisp reference doesn’t mention focus-in-hook and its -out-
variant, except in a list of hooks.  Yet it contains some discussion of
focus events.  To make it clear that the hooks exist, I’ve added a
reference to them in the attached patch.

[0001-doc-lispref-commands.texi-Focus-Events-Mention-focus.patch (text/x-diff, inline)]

From f89a1bc9d70170f77c85ca447b8a8c3efa6f1ccd Mon Sep 17 00:00:00 2001
From: Aaron Ecay <aaronecay <at> gmail.com>
Date: Wed, 21 Oct 2015 19:38:23 +0100
Subject: [PATCH] doc/lispref/commands.texi (Focus Events): Mention
 `focus-{in,out}-hook'.

* doc/lispref/commands.texi (Focus Events): Mention `focus-{in,out}-hook'.
---
 doc/lispref/commands.texi | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 7ddf5ee..1aee2b5 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -1682,6 +1682,9 @@ Focus Events
 so that the focus event comes either before or after the multi-event key
 sequence, and not within it.
 
+Another facility that Emacs provides for running lisp code on focus
+changes is @code{focus-in-hook} and @code{focus-out-hook}.
+
 @node Misc Events
 @subsection Miscellaneous System Events
 
-- 
2.6.1

[Message part 3 (text/plain, inline)]

(I have a copyright assignment on file.)

Thanks,

-- 
Aaron Ecay

Message #8 received at 21728 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Aaron Ecay <aaronecay <at> gmail.com>
Cc: 21728 <at> debbugs.gnu.org
Subject: Re: bug#21728: 25.0.50; [patch] mention focus-{in,out}-hook in manual
Date: Wed, 21 Oct 2015 21:57:52 +0300

> From: Aaron Ecay <aaronecay <at> gmail.com>
> Date: Wed, 21 Oct 2015 19:48:06 +0100
> 
> The emacs lisp reference doesn’t mention focus-in-hook and its -out-
> variant, except in a list of hooks.

No, they are also mentioned in the node "Input Focus".  And the node
"Focus Events", where you suggested the addition, has a
cross-reference to "Input Focus", near its beginning.  So perhaps what
we need is a sentence near that cross-reference that somehow mentions
these two hooks, and all the rest is already in place?  Would you like
to suggest an alternative patch along these lines?

Thanks.

Message #13 received at 21728-done <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Aaron Ecay <aaronecay <at> gmail.com>, 21728-done <at> debbugs.gnu.org
Subject: Re: bug#21728: 25.0.50; [patch] mention focus-{in,out}-hook in manual
Date: Tue, 23 Feb 2016 16:31:47 +1100

Eli Zaretskii <eliz <at> gnu.org> writes:

> No, they are also mentioned in the node "Input Focus".  And the node
> "Focus Events", where you suggested the addition, has a
> cross-reference to "Input Focus", near its beginning.  So perhaps what
> we need is a sentence near that cross-reference that somehow mentions
> these two hooks, and all the rest is already in place?  Would you like
> to suggest an alternative patch along these lines?

Hm...  is that really necessary, though?  With that xref it seems pretty
clear that the user should go to that node for more info on everything
connected with input focus, I think...

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #16 received at 21728 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: aaronecay <at> gmail.com, 21728 <at> debbugs.gnu.org
Subject: Re: bug#21728: 25.0.50; [patch] mention focus-{in,out}-hook in manual
Date: Tue, 23 Feb 2016 17:59:21 +0200

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Cc: Aaron Ecay <aaronecay <at> gmail.com>,  21728-done <at> debbugs.gnu.org
> Date: Tue, 23 Feb 2016 16:31:47 +1100
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > No, they are also mentioned in the node "Input Focus".  And the node
> > "Focus Events", where you suggested the addition, has a
> > cross-reference to "Input Focus", near its beginning.  So perhaps what
> > we need is a sentence near that cross-reference that somehow mentions
> > these two hooks, and all the rest is already in place?  Would you like
> > to suggest an alternative patch along these lines?
> 
> Hm...  is that really necessary, though?  With that xref it seems pretty
> clear that the user should go to that node for more info on everything
> connected with input focus, I think...

The xref doesn't mention the hooks.  I suggested to add a single
sentence that does, that's all.

Message #19 received at 21728 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: larsi <at> gnus.org, aaronecay <at> gmail.com
Cc: 21728 <at> debbugs.gnu.org
Subject: Re: bug#21728: 25.0.50; [patch] mention focus-{in,out}-hook in manual
Date: Tue, 23 Feb 2016 19:44:01 +0200

> Date: Tue, 23 Feb 2016 17:59:21 +0200
> From: Eli Zaretskii <eliz <at> gnu.org>
> Cc: aaronecay <at> gmail.com, 21728 <at> debbugs.gnu.org
> 
> > From: Lars Ingebrigtsen <larsi <at> gnus.org>
> > Cc: Aaron Ecay <aaronecay <at> gmail.com>,  21728-done <at> debbugs.gnu.org
> > Date: Tue, 23 Feb 2016 16:31:47 +1100
> > 
> > Eli Zaretskii <eliz <at> gnu.org> writes:
> > 
> > > No, they are also mentioned in the node "Input Focus".  And the node
> > > "Focus Events", where you suggested the addition, has a
> > > cross-reference to "Input Focus", near its beginning.  So perhaps what
> > > we need is a sentence near that cross-reference that somehow mentions
> > > these two hooks, and all the rest is already in place?  Would you like
> > > to suggest an alternative patch along these lines?
> > 
> > Hm...  is that really necessary, though?  With that xref it seems pretty
> > clear that the user should go to that node for more info on everything
> > connected with input focus, I think...
> 
> The xref doesn't mention the hooks.  I suggested to add a single
> sentence that does, that's all.

Now done on the emacs-25 branch.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.