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

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

[Aaron Ecay]

[-- Attachment #1: Type: text/plain, Size: 261 bytes --]


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.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-lispref-commands.texi-Focus-Events-Mention-focus.patch --]
[-- Type: text/x-diff, Size: 894 bytes --]

From f89a1bc9d70170f77c85ca447b8a8c3efa6f1ccd Mon Sep 17 00:00:00 2001
From: Aaron Ecay <aaronecay@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


[-- Attachment #3: Type: text/plain, Size: 67 bytes --]


(I have a copyright assignment on file.)

Thanks,

-- 
Aaron Ecay

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

[Eli Zaretskii]

> From: Aaron Ecay <aaronecay@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.

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

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@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

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

[Eli Zaretskii]

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: Aaron Ecay <aaronecay@gmail.com>,  21728-done@debbugs.gnu.org
> Date: Tue, 23 Feb 2016 16:31:47 +1100
> 
> Eli Zaretskii <eliz@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.

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

[Eli Zaretskii]

> Date: Tue, 23 Feb 2016 17:59:21 +0200
> From: Eli Zaretskii <eliz@gnu.org>
> Cc: aaronecay@gmail.com, 21728@debbugs.gnu.org
> 
> > From: Lars Ingebrigtsen <larsi@gnus.org>
> > Cc: Aaron Ecay <aaronecay@gmail.com>,  21728-done@debbugs.gnu.org
> > Date: Tue, 23 Feb 2016 16:31:47 +1100
> > 
> > Eli Zaretskii <eliz@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.