From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.bugs Subject: bug#66750: Unhelpful text in C-h v for variables with a lambda form as value Date: Fri, 3 Nov 2023 19:46:27 +0000 Message-ID: References: <83il6k8yyd.fsf@gnu.org> <837cn08o13.fsf@gnu.org> <831qd88dt5.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="6923"; mail-complaints-to="usenet@ciao.gmane.io" Cc: acm@muc.de, Eli Zaretskii , 66750@debbugs.gnu.org, Stefan Kangas To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Nov 03 20:47:42 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qz08s-0001fY-BL for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 03 Nov 2023 20:47:42 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qz08e-0003xu-TH; Fri, 03 Nov 2023 15:47:29 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qz08d-0003vo-35 for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2023 15:47:27 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qz08c-0002Wy-QV for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2023 15:47:26 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qz09C-0007MW-7o for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2023 15:48:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Alan Mackenzie Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 03 Nov 2023 19:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66750 X-GNU-PR-Package: emacs Original-Received: via spool by 66750-submit@debbugs.gnu.org id=B66750.169904083128208 (code B ref 66750); Fri, 03 Nov 2023 19:48:02 +0000 Original-Received: (at 66750) by debbugs.gnu.org; 3 Nov 2023 19:47:11 +0000 Original-Received: from localhost ([127.0.0.1]:59869 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qz08N-0007Ku-0r for submit@debbugs.gnu.org; Fri, 03 Nov 2023 15:47:11 -0400 Original-Received: from mail.muc.de ([193.149.48.3]:36971) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qz08L-0007Ki-LV for 66750@debbugs.gnu.org; Fri, 03 Nov 2023 15:47:10 -0400 Original-Received: (qmail 84606 invoked by uid 3782); 3 Nov 2023 20:46:27 +0100 Original-Received: from acm.muc.de (p4fe159f2.dip0.t-ipconnect.de [79.225.89.242]) (using STARTTLS) by colin.muc.de (tmda-ofmipd) with ESMTP; Fri, 03 Nov 2023 20:46:27 +0100 Original-Received: (qmail 25308 invoked by uid 1000); 3 Nov 2023 19:46:27 -0000 Content-Disposition: inline In-Reply-To: X-Submission-Agent: TMDA/1.3.x (Ph3nix) X-Primary-Address: acm@muc.de X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:273725 Archived-At: Hello, Stefan. On Thu, Nov 02, 2023 at 23:20:36 -0400, Stefan Monnier wrote: > > How do you feel about this, Stefan (M.)? > Seems like it would leave `lambda` as well as the closure > objects unchanged, so it looks good to me. Thanks! But it's not quite so simple as all that. In order to get the doc strings for lambdas into the .elc file, there'll have to be an enhancement of the .elc format. Currently, although doc strings for defuns/demacros/etc. are stored as file name + offset, those for lambdas (which are vanishingly rare at this point) are just stored inline in the .elc, and would get loaded along with the lambdas. > The one thing I'd point out is: try to pick a format for the "data in > docstring" that is easily/naturally extensible (contrary to what I did > for the arglists), so that when we get around to adding support for > things like debugging info we could add it there without having to > invent a new format. I intend to go for simplicity here. A signature at BOL (something like what .elc files have) followed by space separated info fields in a fixed order. Empty fields would have adjacent spaces there. Spaces inside fields (and LFs) could be escaped with \. The whole thing would be terminated by the first (unescaped) LF. As for debugging info in the doc string - well we can argue about that when it comes up. ;-) > Stefan -- Alan Mackenzie (Nuremberg, Germany).