From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Michael Heerdegen Newsgroups: gmane.emacs.devel Subject: Re: master 69d1278527: ; Fix some doc strings in elisp-mode.el Date: Thu, 17 Nov 2022 10:17:44 +0100 Message-ID: <87cz9mx7lz.fsf@web.de> References: <166853515177.10254.3755761779228774904@vcs2.savannah.gnu.org> <20221115175912.8BC26C00613@vcs2.savannah.gnu.org> <87sfiijohr.fsf@web.de> <83sfiidqci.fsf@gnu.org> <87iljexcf2.fsf@web.de> <83h6yydnle.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19802"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Nov 17 10:19:28 2022 Return-path: Envelope-to: ged-emacs-devel@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 1ovb3Q-0004sj-CM for ged-emacs-devel@m.gmane-mx.org; Thu, 17 Nov 2022 10:19:28 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ovb2W-0003x0-0i; Thu, 17 Nov 2022 04:18:32 -0500 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 1ovb2P-0003rn-Tc for emacs-devel@gnu.org; Thu, 17 Nov 2022 04:18:27 -0500 Original-Received: from mout.web.de ([212.227.15.14]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ovb1z-0003Tx-Vd; Thu, 17 Nov 2022 04:18:14 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=web.de; s=s29768273; t=1668676667; bh=uQ/x9gR0Z3YkcXQQeQaZ2efVQkjoNWKKRkWI9u7JnYc=; h=X-UI-Sender-Class:From:To:Cc:Subject:In-Reply-To:References:Date; b=Ijvj3rq3uj5F4tNOwFTy2qd1Oy2/lY24EuKKLtDA5kAQK8rGJtE25OWAMM3KN7mJb XK6Q41xL5pEfs5R+s/rYS7PQA6d2r2kXc0ceP6KLdaYEB8R0KaQErSt1cpGeX1RmqG ZFu+8J/nxhgNUpY+T+W0BquneTjpSJ32dBUvzTFDPXw8P30v42PhC0dSwmu8/zaxSk 6dq/8it0t1XWvzdh/6pFAtllC++9uiDnPgtWOEnL5Id/tfpiilZzYr/5HwrHixz3NQ Hrpw7Poaz2PknNP3w5WREH8y6Ks5uwfpMnj0RgS14op6EOyPrtCwiKPZSAHWhyAAsO qT1cwllUh/NMw== X-UI-Sender-Class: 814a7b36-bfc1-4dae-8640-3722d8ec6cd6 Original-Received: from drachen.dragon ([88.66.71.129]) by smtp.web.de (mrweb006 [213.165.67.108]) with ESMTPSA (Nemesis) id 1MIc3F-1ogy1m1ZZt-00EcVR; Thu, 17 Nov 2022 10:17:47 +0100 In-Reply-To: <83h6yydnle.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 17 Nov 2022 09:52:45 +0200") X-Provags-ID: V03:K1:wc9xkqc0RL31XCgY4wc/8bebH7yWctrOM/aHrTUeCu17ceWTXcD eyosF2LBUD+0WFEJ+GkPa0wIUDD35KcxPcAeXtRY2aUkpQTX5ry0BaVnDDsOeUbck5d2Vv9 AmcYifH6wIitG86cL3HXEJ4ZmgBotVZTujYh3x5E5dy/NtOMv9C98yQZBPc6g9K7khgWYTu SzH4ovPQZzkKomck8YrSA== UI-OutboundReport: notjunk:1;M01:P0:qI1xSWec2KY=;/s/o8pcUwhsm3Mov7bb361zueyD Moayd8QOhDiqc6hoE8aLNGtN9aqbUHzLGQqNyyoJ+KutyHOseS7M5qEdJ/mAdbq04RkN/hGUd yx2oDN61OlKrXJneweZxEJEeZ3nOpYaLHn3MjDldxodt5BLLvmPyexQNEooUR7SymB9AtWMF5 WjyI3SPj0K7DgtLmH7qjwMJx40fUJx4Wru+xHkhriTHANhEXMQcj0FDl87HYFD5U1Te/3LEzs XyuDuxY/UWsfUX0nKjo/3Sw9DGnqMVj2rvXeBm72PCAVLNwV06npoEItfAKDUCdcs6kfZYqxD i67z1HtCAoiTrfWoZvMmNPEO8ijMWTZNyv0wXmNQRVQFFuc2pAcUa3UeDr6sqKg29Yc6QKVOb /8DMtfP0HBt9f1SYiChZ6BYhslWyRLgxQINRCPjfg3oytVD/zwBWzh3o+CklvsPSshPP4GiGa y2NaGSrupEeodKW3tbSiMbfI4nxprXMTo/ocgSONjg4zKj4dyxLHg5bJXBHsMDfWN1EFL7nL3 evNJ50njx7NZ+9uWJ9TJ0erPHIKd8LZHxgJ0qaaaNvYw9ZT1Ii3DFbDeVOcrJnjM+TI0XlCHQ VE2x0t7JJ+tusjb/Wt3a6VChkKhkL1mZXJmNnAliZ4rf+WwmbWtfiN5EyqO3SCOO1nN3o5TmL DemJ5irjqsp/2o1IFEIiMFqPV6Z0GfTyDPoqxnCdB0UHD3taMnAH8c6/YroWrmtcs/08xFQpw V5PVlnsaEZF3XUTWX/z0X9V5glJxUvRFZ0Tsa4/hwQfGAFF19sFlwWx0GPahNRapZcH/2pUt Received-SPF: pass client-ip=212.227.15.14; envelope-from=michael_heerdegen@web.de; helo=mout.web.de X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:300028 Archived-At: Eli Zaretskii writes: > Maybe I do, I don't remember. But using it doesn't necessarily mean I > can immediately understand the relation to what the doc string says > (or doesn't say). (info "(elisp) Instrumenting") describes everything completely and correctly AFAIK. Which means: EDEBUG-IT is the prefix arg and when it is specified, then the top-level form to be evaluated is first instrumented, and then evaluated. Details seem to be slightly more complicated (`edebug-read-and-maybe-wrap-form1'): defining forms are treated a bit specially. But that detail doesn't need to be explained in that docstring. `edebug-all-defs' non-nil reverts the meaning of the prefix arg of C-M-x. That probably should be added to the docstring. The code... I can also only read the code, it's not trivial: when using the prefix arg, edebug is first `requir'ed. Loading edebug installs an advice on `eval-defun' - that's why the recursive call of `eval-defun' is not nonsense (you may want to add a comment to the code...). The advice's name is `edebug--eval-defun'. And that works by advising `load-read-function' to make it return instrumented code. All only AFAIU. Anything else I could try to answer in particular? Maybe also Stefan wants to help... Michael.