From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#30958: 26.0.91; No documentation for key and value in the function passed to `map-keymap' Date: Mon, 26 Mar 2018 21:15:38 -0700 (PDT) Message-ID: References: <4f0b5f4f-74bd-5610-0cff-14da7ca90f39@topbug.net> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1522124050 18513 195.159.176.226 (27 Mar 2018 04:14:10 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 27 Mar 2018 04:14:10 +0000 (UTC) To: Hong Xu , 30958@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Mar 27 06:14:06 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f0fzp-0004io-Tz for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Mar 2018 06:14:06 +0200 Original-Received: from localhost ([::1]:60254 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f0g1t-0004lo-B4 for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Mar 2018 00:16:13 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:46165) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f0g1l-0004lD-Gb for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 00:16:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f0g1i-00077k-Bp for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 00:16:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:47124) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f0g1i-00077J-6p for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 00:16:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f0g1h-0004LM-PE for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 00:16:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 27 Mar 2018 04:16:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 30958 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 30958-submit@debbugs.gnu.org id=B30958.152212415116680 (code B ref 30958); Tue, 27 Mar 2018 04:16:01 +0000 Original-Received: (at 30958) by debbugs.gnu.org; 27 Mar 2018 04:15:51 +0000 Original-Received: from localhost ([127.0.0.1]:55021 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f0g1W-0004Ky-RG for submit@debbugs.gnu.org; Tue, 27 Mar 2018 00:15:51 -0400 Original-Received: from aserp2130.oracle.com ([141.146.126.79]:46526) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f0g1U-0004Kk-Fh for 30958@debbugs.gnu.org; Tue, 27 Mar 2018 00:15:49 -0400 Original-Received: from pps.filterd (aserp2130.oracle.com [127.0.0.1]) by aserp2130.oracle.com (8.16.0.22/8.16.0.22) with SMTP id w2R44HVU119510; Tue, 27 Mar 2018 04:15:42 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2017-10-26; bh=gNRA2FvlTapUpxJ5TSqv6wS5iYHNCML99M1dUXLGxNI=; b=nCcyPLevzRrmp/1C1Q9DGRks+Zclug/WI2ffw0EJmBsIUqsP956JrLz4ORXnD0zsd3rD 6JtfTgGb5KuO2XQgucoLYVHTAgtOS1SnZIOu7oUnvyvfT+lING/OXZx8B9AVaQ2U1NRq Bc/qGYgAd+tYTtYZ7ztah0F0KQjxN4VK7n5DwIWQH+AP8caW2/f8QeXAiVEs1yHWaNCH hlxhjrjhI0IfO4fIoFbn0L0yNSx/txtLNGjxsKHKc7eXXyRj3wnHgKzrnsg8tQOi06Ce YMFyChdjgb2kefiTw2Qs6XGNUafa4+8cByFcxGsCn0xaTzAJUyGUypFCesoSUUnL3X36 Tg== Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by aserp2130.oracle.com with ESMTP id 2gyek4017q-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 27 Mar 2018 04:15:42 +0000 Original-Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id w2R4Feo0029982 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 27 Mar 2018 04:15:41 GMT Original-Received: from abhmp0014.oracle.com (abhmp0014.oracle.com [141.146.116.20]) by aserv0122.oracle.com (8.14.4/8.14.4) with ESMTP id w2R4Fedj021963; Tue, 27 Mar 2018 04:15:40 GMT In-Reply-To: <4f0b5f4f-74bd-5610-0cff-14da7ca90f39@topbug.net> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4666.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=8844 signatures=668695 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=990 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1711220000 definitions=main-1803270044 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:144646 Archived-At: > A callback function should be passed to `map-keymap'. However, > the description of the callback function seems to be missing > (undocumented). For example, the value does not seems to always be a > function. It is sometimes an alist, sometimes a more complicated list. >=20 > I think this might have never been documented. If it is documented, it > would be greatly appreciated if a pointer to the actual documentation > can be added to the document of `map-keymap'. (If this report is clear to others then don't worry about it, but it's not clear to me.) I wouldn't call the FUNCTION arg a "callback" function, but it's the only function that is passed, AFAIK, so I guess that's the one you mean. What makes you think it doesn't always need to be a function? Grepping the Emacs Lisp files, I don't see any cases where it is not a function (or where the KEYMAP arg is a function). FUNCTION is described pretty well in the doc, I think - the args it is passed are described. If you instead meant the KEYMAP arg (whose value is not a function, AFAIK), then there is a whole section of the Elisp manual devoted do describing that, including the various forms a keymap can take (e.g. particular kinds of alists). See https://www.gnu.org/software/emacs/manual/html_node/elisp/Keymaps.html and its child nodes. (I'm probably missing something that you meant. If so, please ignore.)