From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#15993: 24.3.50; doc of `set-temporary-overlay-map' - explain "used only once" Date: Sat, 8 Feb 2014 15:00:16 -0800 (PST) Message-ID: <466c1988-c807-45fe-af2e-179333ce9ac9@default> References: <3f303fda-e66b-4d9c-a1a7-da7d9950d09d@default> <87ob2i9ub6.fsf@building.gnus.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1391900480 11898 80.91.229.3 (8 Feb 2014 23:01:20 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 8 Feb 2014 23:01:20 +0000 (UTC) Cc: 15993@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Feb 09 00:01:26 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1WCGto-0000kw-7C for geb-bug-gnu-emacs@m.gmane.org; Sun, 09 Feb 2014 00:01:24 +0100 Original-Received: from localhost ([::1]:48293 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WCGtn-0005kN-Md for geb-bug-gnu-emacs@m.gmane.org; Sat, 08 Feb 2014 18:01:23 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51196) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WCGtb-0005jZ-Dn for bug-gnu-emacs@gnu.org; Sat, 08 Feb 2014 18:01:19 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WCGtS-00042m-Ql for bug-gnu-emacs@gnu.org; Sat, 08 Feb 2014 18:01:11 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:44312) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WCGtS-00042i-NI for bug-gnu-emacs@gnu.org; Sat, 08 Feb 2014 18:01:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1WCGtS-00006C-02 for bug-gnu-emacs@gnu.org; Sat, 08 Feb 2014 18:01:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 08 Feb 2014 23:01:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 15993 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 15993-submit@debbugs.gnu.org id=B15993.1391900426320 (code B ref 15993); Sat, 08 Feb 2014 23:01:01 +0000 Original-Received: (at 15993) by debbugs.gnu.org; 8 Feb 2014 23:00:26 +0000 Original-Received: from localhost ([127.0.0.1]:58329 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WCGsr-000055-5W for submit@debbugs.gnu.org; Sat, 08 Feb 2014 18:00:25 -0500 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:50372) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WCGso-0008WV-AV for 15993@debbugs.gnu.org; Sat, 08 Feb 2014 18:00:23 -0500 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s18N0Jwc000346 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sat, 8 Feb 2014 23:00:20 GMT Original-Received: from aserz7021.oracle.com (aserz7021.oracle.com [141.146.126.230]) by ucsinet22.oracle.com (8.14.5+Sun/8.14.5) with ESMTP id s18N0IX7024620 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Sat, 8 Feb 2014 23:00:19 GMT Original-Received: from abhmp0011.oracle.com (abhmp0011.oracle.com [141.146.116.17]) by aserz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s18N0Ik6002448; Sat, 8 Feb 2014 23:00:18 GMT In-Reply-To: <87ob2i9ub6.fsf@building.gnus.org> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:84996 Archived-At: > > This pertains to both the Elisp manual and the doc string. > > > > This function puts a keymap in place temporarily, and that keymap > > overrides most other keymaps. The important question of what > > "temporarily" means here is not answered by the doc. It says only > > "Normally, MAP is used only once." A user is left to guess what > > "used only once" means. Only one occurrence of what? >=20 > The doc string now says >=20 > Set MAP as a temporary keymap taking precedence over other keymaps. > Normally, MAP is used only once, to look up the very next key. > However, if the optional argument KEEP-PRED is t, MAP stays > active if a key from MAP is used. KEEP-PRED can also be a > function of no arguments: if it returns non-nil, then MAP stays > active. >=20 > which I think is clear enough. Yes, the bug was fixed. FYI, this was the text from the build where I submitted the bug report: ,---- | set-temporary-overlay-map is a compiled Lisp function in `subr.el'. |=20 | (set-temporary-overlay-map MAP &optional KEEP-PRED ON-EXIT) |=20 | Set MAP as a temporary keymap taking precedence over most other keymaps. | Note that this does NOT take precedence over the "overriding" maps | `overriding-terminal-local-map' and `overriding-local-map' (or the | `keymap' text property). Unlike those maps, if no match for a key is | found in MAP, the normal key lookup sequence then continues. |=20 | Normally, MAP is used only once. If the optional argument | KEEP-PRED is t, MAP stays active if a key from MAP is used. | KEEP-PRED can also be a function of no arguments: if it returns | non-nil then MAP stays active. |=20 | Optional ON-EXIT argument is a function that is called after the | deactivation of MAP. `----