From unknown Sun Aug 17 23:33:57 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#42776 <42776@debbugs.gnu.org> To: bug#42776 <42776@debbugs.gnu.org> Subject: Status: Obscure documentation of `edebug-form-data' in edebug.el Reply-To: bug#42776 <42776@debbugs.gnu.org> Date: Mon, 18 Aug 2025 06:33:57 +0000 retitle 42776 Obscure documentation of `edebug-form-data' in edebug.el reassign 42776 emacs submitter 42776 Alan Mackenzie severity 42776 minor tag 42776 fixed thanks From debbugs-submit-bounces@debbugs.gnu.org Sun Aug 09 11:03:52 2020 Received: (at submit) by debbugs.gnu.org; 9 Aug 2020 15:03:52 +0000 Received: from localhost ([127.0.0.1]:33270 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1k4mrY-0007Gu-Fb for submit@debbugs.gnu.org; Sun, 09 Aug 2020 11:03:52 -0400 Received: from lists.gnu.org ([209.51.188.17]:57116) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1k4mrV-0007Gl-C1 for submit@debbugs.gnu.org; Sun, 09 Aug 2020 11:03:51 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53884) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1k4mrV-0006As-4X for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2020 11:03:49 -0400 Received: from colin.muc.de ([193.149.48.1]:34390 helo=mail.muc.de) by eggs.gnu.org with smtp (Exim 4.90_1) (envelope-from ) id 1k4mrS-000808-TF for bug-gnu-emacs@gnu.org; Sun, 09 Aug 2020 11:03:48 -0400 Received: (qmail 43572 invoked by uid 3782); 9 Aug 2020 15:03:42 -0000 Received: from acm.muc.de (p2e5d5e8f.dip0.t-ipconnect.de [46.93.94.143]) by localhost.muc.de (tmda-ofmipd) with ESMTP; Sun, 09 Aug 2020 17:03:42 +0200 Received: (qmail 26677 invoked by uid 1000); 9 Aug 2020 15:03:41 -0000 Date: Sun, 9 Aug 2020 15:03:41 +0000 To: bug-gnu-emacs@gnu.org Subject: Obscure documentation of `edebug-form-data' in edebug.el Message-ID: <20200809150341.GA26635@ACM> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline X-Delivery-Agent: TMDA/1.1.12 (Macallan) From: Alan Mackenzie X-Primary-Address: acm@muc.de Received-SPF: pass client-ip=193.149.48.1; envelope-from=acm@muc.de; helo=mail.muc.de X-detected-operating-system: by eggs.gnu.org: First seen = 2020/08/09 11:03:43 X-ACL-Warn: Detected OS = FreeBSD 9.x or newer [fuzzy] X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.6 (-) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.6 (--) Hello, Emacs. In the master branch: The doc string of edebug-form-data begins thusly: "A list of entries associating symbols with buffer regions. Each entry is an `edebug--form-data' struct with fields: SYMBOL, BEGIN-MARKER, and END-MARKER. The markers are at the beginning and end of an entry level form and SYMBOL is a symbol that holds all edebug related information for the form on its property list." The following extract from this is obscure: "...the beginning and end of an entry level form ...." What in heaven or earth is an "entry level form"? What is it for? Less major questions are: What is the nature of the "association" of the symbols with the buffer regions? Which buffer gets its regions associated? It seems the only way to make sense of this doc string is by reading edebug.el's source to find out what it means. This isn't what doc strings are supposed to be for. This is a bug. -- Alan Mackenzie (Nuremberg, Germany). From debbugs-submit-bounces@debbugs.gnu.org Wed Dec 09 08:37:32 2020 Received: (at 42776) by debbugs.gnu.org; 9 Dec 2020 13:37:32 +0000 Received: from localhost ([127.0.0.1]:33074 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kmzet-0007DH-Vh for submit@debbugs.gnu.org; Wed, 09 Dec 2020 08:37:32 -0500 Received: from quimby.gnus.org ([95.216.78.240]:37698) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kmzer-0007D1-OO for 42776@debbugs.gnu.org; Wed, 09 Dec 2020 08:37:30 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=SKdm504aUbEuRrSIQRAIg5nqFmBKhJz+yWmWD/RTBfU=; b=e7KeQ6Jn129FRAJKFcz2qlT4CV H1dHKkG3es7Rxtcbd/n49+1b0+Wh+yn59p3kTrId9kC9QAwIaJ3fHmAoh4GR9YQiNrk3qU6L3BTB1 EigJSdV7Q4ym61FY2QFqQxhDSMZSNJxGE6h69c7hBdEzrF4cxjXa7QdyoHaHag6ICiM8=; Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kmzej-0001Y0-FL; Wed, 09 Dec 2020 14:37:24 +0100 From: Lars Ingebrigtsen To: Alan Mackenzie Subject: Re: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el References: <20200809150341.GA26635@ACM> X-Now-Playing: Sibusile Xaba's _Ngiwu Shawbada_: "Elihle" Date: Wed, 09 Dec 2020 14:37:20 +0100 In-Reply-To: <20200809150341.GA26635@ACM> (Alan Mackenzie's message of "Sun, 9 Aug 2020 15:03:41 +0000") Message-ID: <87k0tr3xtb.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: Alan Mackenzie writes: > The doc string of edebug-form-data begins thusly: > > "A list of entries associating symbols with buffer regions. > Each entry is an `edebug--form-data' struct with fields: > SYMBOL, BEGIN-MARKER, a [...] Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 42776 Cc: 42776@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Alan Mackenzie writes: > The doc string of edebug-form-data begins thusly: > > "A list of entries associating symbols with buffer regions. > Each entry is an `edebug--form-data' struct with fields: > SYMBOL, BEGIN-MARKER, and END-MARKER. The markers > are at the beginning and end of an entry level form and SYMBOL is > a symbol that holds all edebug related information for the form on its > property list." > > The following extract from this is obscure: "...the beginning and end of > an entry level form ...." > > What in heaven or earth is an "entry level form"? What is it for? I'm guessing that's just a typo for "of a form"? > Less major questions are: What is the nature of the "association" of the > symbols with the buffer regions? Which buffer gets its regions > associated? > > It seems the only way to make sense of this doc string is by reading > edebug.el's source to find out what it means. This isn't what doc > strings are supposed to be for. I'm not extremely familiar with the edebug data structures -- can somebody clarify this doc string? -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no From debbugs-submit-bounces@debbugs.gnu.org Sat Dec 26 04:01:59 2020 Received: (at 42776) by debbugs.gnu.org; 26 Dec 2020 09:01:59 +0000 Received: from localhost ([127.0.0.1]:58711 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kt5SZ-0002JK-JS for submit@debbugs.gnu.org; Sat, 26 Dec 2020 04:01:59 -0500 Received: from eggs.gnu.org ([209.51.188.92]:44696) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kt5SX-0002J7-Gq for 42776@debbugs.gnu.org; Sat, 26 Dec 2020 04:01:58 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:58214) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kt5SS-0007Jf-3R; Sat, 26 Dec 2020 04:01:52 -0500 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1195 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1kt5SR-0007R7-Fo; Sat, 26 Dec 2020 04:01:51 -0500 Date: Sat, 26 Dec 2020 11:01:36 +0200 Message-Id: <83k0t5lz4f.fsf@gnu.org> From: Eli Zaretskii To: Lars Ingebrigtsen In-Reply-To: <87k0tr3xtb.fsf@gnus.org> (message from Lars Ingebrigtsen on Wed, 09 Dec 2020 14:37:20 +0100) Subject: Re: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el References: <20200809150341.GA26635@ACM> <87k0tr3xtb.fsf@gnus.org> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 42776 Cc: acm@muc.de, 42776@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Lars Ingebrigtsen > Date: Wed, 09 Dec 2020 14:37:20 +0100 > Cc: 42776@debbugs.gnu.org > > Alan Mackenzie writes: > > > The doc string of edebug-form-data begins thusly: > > > > "A list of entries associating symbols with buffer regions. > > Each entry is an `edebug--form-data' struct with fields: > > SYMBOL, BEGIN-MARKER, and END-MARKER. The markers > > are at the beginning and end of an entry level form and SYMBOL is > > a symbol that holds all edebug related information for the form on its > > property list." > > > > The following extract from this is obscure: "...the beginning and end of > > an entry level form ...." > > > > What in heaven or earth is an "entry level form"? What is it for? > > I'm guessing that's just a typo for "of a form"? "Of an instrumented form", I guess? Any reason not to modify the doc string with that? > > Less major questions are: What is the nature of the "association" of the > > symbols with the buffer regions? Which buffer gets its regions > > associated? The buffer in which the instrumented form lives. IOW, the source code of the form you instrumented. From debbugs-submit-bounces@debbugs.gnu.org Sat Dec 26 17:16:07 2020 Received: (at 42776) by debbugs.gnu.org; 26 Dec 2020 22:16:07 +0000 Received: from localhost ([127.0.0.1]:60057 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ktHr5-0006jO-05 for submit@debbugs.gnu.org; Sat, 26 Dec 2020 17:16:07 -0500 Received: from quimby.gnus.org ([95.216.78.240]:54370) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ktHr2-0006bm-RO for 42776@debbugs.gnu.org; Sat, 26 Dec 2020 17:16:05 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=dTm1JBlHTuR+Uj/hyKzHuN2RKBB0K1RbUNPu4osjLcQ=; b=snv4VhOedMBeI1Nr4X+EnnAuqY 4hkzakbTtLu+FS/dtVujvOC8K6qfsnWzjcXGWKh4OnCXyRjyJ//DPyvIDLdqza++UljuqvjfpnQYj 7wPXGYeqDxX+8cmPefdM5EmZUbhHoYMYyofYp3l8fEDF4z9whtbXabpue+Cb0CFKdzTo=; Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ktHqt-0000X8-Az; Sat, 26 Dec 2020 23:15:57 +0100 From: Lars Ingebrigtsen To: Eli Zaretskii Subject: Re: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el References: <20200809150341.GA26635@ACM> <87k0tr3xtb.fsf@gnus.org> <83k0t5lz4f.fsf@gnu.org> Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAABGdBTUEAALGPC/xhBQAAACBj SFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAALVBMVEUGAwQ1TFgiHycT DhU0JjpRZ2hVeYNri42grY6Mk2SUVx1ziXPByJ4oUIv///+ana8kAAAAAWJLR0QOb70wTwAAAAd0 SU1FB+QMGhU1KDY8ohkAAADgSURBVDjLY2AYBfQBjAo4JBQFsIszC4rgMCk0DLtZ5mlpAVglwsvL SrCJs7SXl5cZYIozuXcAZWYtQpNidgyM6GjfGpoYPWsVkhyzY6gQw4yO7q2hgUDmzlWrnCByiqFC BgysJzo6doeGKjAw696tnrlqFQODiqgISF6j4wxIC8jzzIp303cyiIpAfBXRceYEUCIFYrbKXQao Z5lmdpw5AzILajMzzH7W3VAJ9ID0hkkko/lje0XPmTMn2rellaL5OzQ0NHpraKigIMwSogEzqRro BZhJlsAABLxGvEGUAwADOkOmFZcKowAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMC0xMi0yNlQyMTo1 Mzo0MCswMDowMLgwpvUAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjAtMTItMjZUMjE6NTM6NDArMDA6 MDDJbR5JAAAAAElFTkSuQmCC X-Now-Playing: Pink Floyd's _The Dark Side Of The Moon_: "Brain Damage" Date: Sat, 26 Dec 2020 23:15:53 +0100 In-Reply-To: <83k0t5lz4f.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 26 Dec 2020 11:01:36 +0200") Message-ID: <87k0t49pt2.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: Eli Zaretskii writes: > "Of an instrumented form", I guess? Any reason not to modify the doc > string with that? Looking at the code, that does seem to be the intended meaning (I think), so I've now made that change. Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 42776 Cc: acm@muc.de, 42776@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Eli Zaretskii writes: > "Of an instrumented form", I guess? Any reason not to modify the doc > string with that? Looking at the code, that does seem to be the intended meaning (I think), so I've now made that change. >> > Less major questions are: What is the nature of the "association" of the >> > symbols with the buffer regions? Which buffer gets its regions >> > associated? > > The buffer in which the instrumented form lives. IOW, the source code > of the form you instrumented. Yup. And I think that's everything covered? So I'm closing this bug report. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no From debbugs-submit-bounces@debbugs.gnu.org Sat Dec 26 17:16:20 2020 Received: (at control) by debbugs.gnu.org; 26 Dec 2020 22:16:20 +0000 Received: from localhost ([127.0.0.1]:60060 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ktHrI-0006vl-AR for submit@debbugs.gnu.org; Sat, 26 Dec 2020 17:16:20 -0500 Received: from quimby.gnus.org ([95.216.78.240]:54388) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ktHrG-0006ps-M1 for control@debbugs.gnu.org; Sat, 26 Dec 2020 17:16:19 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Subject:From:To:Message-Id:Date:Sender:Reply-To:Cc: MIME-Version:Content-Type:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=FPr7+otJ0T+yaV0OneO0XR78IVcCc/yroDg/4LfFmBA=; b=hERvaE5Gt4Fm0SG1c5ueF/pyOP BozVA1U7bRK/Ppz/krcVtYgQyNIGxG0HrM/lArT6XrXdN5Wa2l+5kNiYcBVEQKi5//+SXsv4/NodL KiNvATRmzCzRz1BG+Sa3KjYXgbKecGXpHk16j/K87LCom2siVvO4ttT9QLr5hDVCY9fY=; Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ktHr9-0000XL-46 for control@debbugs.gnu.org; Sat, 26 Dec 2020 23:16:13 +0100 Date: Sat, 26 Dec 2020 23:16:10 +0100 Message-Id: <87im8o9psl.fsf@gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #42776 X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: tags 42776 fixed close 42776 28.1 quit Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) tags 42776 fixed close 42776 28.1 quit From unknown Sun Aug 17 23:33:57 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sun, 24 Jan 2021 12:24:06 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator