From unknown Fri Sep 05 11:52:32 2025 X-Loop: help-debbugs@gnu.org Subject: bug#69745: [PATCH] Fix incorrect Edebug docstrings Resent-From: Matt Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 12 Mar 2024 12:22:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 69745 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: 69745@debbugs.gnu.org X-Debbugs-Original-To: "bug-gnu-emacs" Received: via spool by submit@debbugs.gnu.org id=B.171024606615233 (code B ref -1); Tue, 12 Mar 2024 12:22:01 +0000 Received: (at submit) by debbugs.gnu.org; 12 Mar 2024 12:21:06 +0000 Received: from localhost ([127.0.0.1]:41990 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rk17x-0003xc-Eu for submit@debbugs.gnu.org; Tue, 12 Mar 2024 08:21:06 -0400 Received: from lists.gnu.org ([209.51.188.17]:47298) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rjyCd-0003ux-L2 for submit@debbugs.gnu.org; Tue, 12 Mar 2024 05:13:47 -0400 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 1rjyC4-00076l-QB for bug-gnu-emacs@gnu.org; Tue, 12 Mar 2024 05:13:08 -0400 Received: from sender4-pp-f112.zoho.com ([136.143.188.112]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rjyC3-00012x-13 for bug-gnu-emacs@gnu.org; Tue, 12 Mar 2024 05:13:08 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1710234782; cv=none; d=zohomail.com; s=zohoarc; b=Ys9Hh4NVIE+J2ZluJNP0WA2kBoVkwltrmKYcKCENbo3/7Kg3I7vZtpITlwPD1ZYhWXnlLP6Ht2pFRgWy1D+lC2jPjXvBYUIa0JP9SXVBJRnJZqjDjfNVwMB4U04xvjzYlt8f4UQqn5LZN/Z759qXj7L+nUXehosN7eLjjJ1AhAY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1710234782; h=Content-Type:Date:Date:From:From:MIME-Version:Message-ID:Subject:Subject:To:To:Message-Id:Reply-To:Cc; bh=0sjeLOdxMcLae2h4F3WqL45sc/WHuR6AF9X+L9oXr4U=; b=EADFvdkiuhIOwEqa+Tn4ilJ2mBU7LhgLbu6XTb8mQmo6yEoikaXVTwfzldmM3CDgYxNrjf0EYgL58ws5tmnY0vribhgmQUQM8Co7wGWN5CA+9CJ8psdBAzvM2FgqP/rzIhSxywK+RgGbqTcg2yPMi4IWfCfI0wUVC2dcey5kQ+E= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1710234782; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Message-Id:Message-Id:In-Reply-To:Subject:Subject:MIME-Version:Content-Type:Reply-To:Cc; bh=0sjeLOdxMcLae2h4F3WqL45sc/WHuR6AF9X+L9oXr4U=; b=gIR96VYskQgjRjit1QmV3KXqhPbGO/6Spe/p4ZoX8V5bHUjbdCLN5ZO5q9zrAvB1 K5Psj+AhkFALUlVcw9fd6mahteNg8nmfokVLG6Hskan66HZ05DF53ApeNCfrRhQqJyf wvyMMJCAe57EctHluHESQl9wp/DvH7WLchJ8mXb0= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1710234781371830.9519196074343; Tue, 12 Mar 2024 02:13:01 -0700 (PDT) Date: Tue, 12 Mar 2024 10:13:01 +0100 From: Matt Message-Id: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> In-Reply-To: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="----=_Part_755978_505512936.1710234781283" Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail X-Zoho-Virus-Status: 1 X-Zoho-AV-Stamp: zmail-av-1.1.0/210.162.90 Received-SPF: pass client-ip=136.143.188.112; envelope-from=matt@excalamus.com; helo=sender4-pp-f112.zoho.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.3 (-) X-Mailman-Approved-At: Tue, 12 Mar 2024 08:21:03 -0400 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.3 (--) ------=_Part_755978_505512936.1710234781283 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hi, When edebug-print-length and edebug-print-level are nil, they default to pr= int-level and print-length. The docstrings currently say the opposite, tha= t edebug defaults to the print variables if non-nil. Thank you -- Matt Trzcinski Emacs Org contributor (ob-shell) Learn more about Org mode at https://orgmode.org Support Org development at=C2=A0https://liberapay.com/org-mode ------=_Part_755978_505512936.1710234781283 Content-Type: application/octet-stream; name=fix-incorrect-edebug-docstring.diff Content-Transfer-Encoding: 7bit X-ZM_AttachId: 139295275812830220 Content-Disposition: attachment; filename=fix-incorrect-edebug-docstring.diff diff --git a/lisp/emacs-lisp/edebug.el b/lisp/emacs-lisp/edebug.el index 4c7dbb4ef8c..a33593dca4c 100644 --- a/lisp/emacs-lisp/edebug.el +++ b/lisp/emacs-lisp/edebug.el @@ -193,10 +193,10 @@ Use this with caution since it is not debugged." (defcustom edebug-print-length 50 - "If non-nil, default value of `print-length' for printing results in Edebug." + "If nil, default value of `print-length' is used for printing results in Edebug." :type '(choice integer (const nil))) (defcustom edebug-print-level 50 - "If non-nil, default value of `print-level' for printing results in Edebug." + "If nil, default value of `print-level' is used for printing results in Edebug." :type '(choice integer (const nil))) (defcustom edebug-print-circle t "If non-nil, default value of `print-circle' for printing results in Edebug." ------=_Part_755978_505512936.1710234781283-- From unknown Fri Sep 05 11:52:32 2025 X-Loop: help-debbugs@gnu.org Subject: bug#69745: [PATCH] Fix incorrect Edebug docstrings Resent-From: Andreas Schwab Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 12 Mar 2024 13:02:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69745 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Matt Cc: 69745@debbugs.gnu.org Received: via spool by 69745-submit@debbugs.gnu.org id=B69745.171024851519964 (code B ref 69745); Tue, 12 Mar 2024 13:02:02 +0000 Received: (at 69745) by debbugs.gnu.org; 12 Mar 2024 13:01:55 +0000 Received: from localhost ([127.0.0.1]:42014 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rk1lQ-0005Br-6i for submit@debbugs.gnu.org; Tue, 12 Mar 2024 09:01:55 -0400 Received: from smtp-out1.suse.de ([195.135.223.130]:35178) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rk1lD-0005BE-8z for 69745@debbugs.gnu.org; Tue, 12 Mar 2024 09:01:50 -0400 Received: from hawking.nue2.suse.org (unknown [10.168.4.11]) by smtp-out1.suse.de (Postfix) with ESMTP id 8F037376B7; Tue, 12 Mar 2024 13:00:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1710248428; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HkB5TPYxa00ZGqj9ramWY+fRPG1Idm2dcEYJQIJ8PkI=; b=qvVmZNbR+j5/OvBXBcZIHbtxNR0vfB53n0Qjf8G8vmbfeZz+tyYCvq7ZHtMYbRN/bFF8b5 aM19w+Mbvqx4OrOLeQyaEVTHdsGtfYnNU8xpkHhHp0Stcm6hcF1qXWkFqk287ubOU4E7ea OwQjPbkeXjH/XY4id0IFWbQ+i61gKpg= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1710248428; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HkB5TPYxa00ZGqj9ramWY+fRPG1Idm2dcEYJQIJ8PkI=; b=fgs/uSZZaWAc84lzp4u3pmdJfH1MnMYrQ+0IC38VrPk2mmqtfDCD3IyciXkThYJBP/n/QN JIYPKAdf+pYuRvAw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1710248428; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HkB5TPYxa00ZGqj9ramWY+fRPG1Idm2dcEYJQIJ8PkI=; b=qvVmZNbR+j5/OvBXBcZIHbtxNR0vfB53n0Qjf8G8vmbfeZz+tyYCvq7ZHtMYbRN/bFF8b5 aM19w+Mbvqx4OrOLeQyaEVTHdsGtfYnNU8xpkHhHp0Stcm6hcF1qXWkFqk287ubOU4E7ea OwQjPbkeXjH/XY4id0IFWbQ+i61gKpg= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1710248428; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HkB5TPYxa00ZGqj9ramWY+fRPG1Idm2dcEYJQIJ8PkI=; b=fgs/uSZZaWAc84lzp4u3pmdJfH1MnMYrQ+0IC38VrPk2mmqtfDCD3IyciXkThYJBP/n/QN JIYPKAdf+pYuRvAw== Received: by hawking.nue2.suse.org (Postfix, from userid 17005) id 784564A04EC; Tue, 12 Mar 2024 13:59:58 +0100 (CET) From: Andreas Schwab In-Reply-To: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> (matt@excalamus.com's message of "Tue, 12 Mar 2024 10:13:01 +0100") References: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> X-Yow: Are we on STRIKE yet? Date: Tue, 12 Mar 2024 13:59:58 +0100 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Authentication-Results: smtp-out1.suse.de; none X-Spam-Level: X-Spam-Score: -3.23 X-Spamd-Result: default: False [-3.23 / 50.00]; ARC_NA(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000]; MIME_GOOD(-0.10)[text/plain]; DKIM_SIGNED(0.00)[suse.de:s=susede2_rsa,suse.de:s=susede2_ed25519]; NEURAL_HAM_SHORT(-0.20)[-0.978]; RCPT_COUNT_TWO(0.00)[2]; DBL_BLOCKED_OPENRESOLVER(0.00)[suse.de:email]; FUZZY_BLOCKED(0.00)[rspamd.com]; RCVD_COUNT_ZERO(0.00)[0]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; MID_RHS_MATCH_FROM(0.00)[]; BAYES_HAM(-1.93)[94.66%] X-Spam-Flag: NO X-Spam-Score: 0.0 (/) 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 (---) On Mär 12 2024, Matt wrote: > When edebug-print-length and edebug-print-level are nil, they default to print-level and print-length. The docstrings currently say the opposite, that edebug defaults to the print variables if non-nil. That's not correct. The edebug-print-* variables, when non-nil, override the corresponding print-* variables during printing (see edebug-safe-prin1-to-string). When they are nil, they have no effect. > (defcustom edebug-print-length 50 > - "If non-nil, default value of `print-length' for printing results in Edebug." > + "If nil, default value of `print-length' is used for printing results in Edebug." That fails to say what happens if it is non-nil, which is the actual relevant information. -- Andreas Schwab, SUSE Labs, schwab@suse.de GPG Key fingerprint = 0196 BAD8 1CE9 1970 F4BE 1748 E4D4 88E3 0EEA B9D7 "And now for something completely different." From unknown Fri Sep 05 11:52:32 2025 X-Loop: help-debbugs@gnu.org Subject: bug#69745: [PATCH] Fix incorrect Edebug docstrings Resent-From: Matt Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Mar 2024 17:28:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69745 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: "Andreas Schwab" Cc: 69745 <69745@debbugs.gnu.org> Received: via spool by 69745-submit@debbugs.gnu.org id=B69745.17105236559061 (code B ref 69745); Fri, 15 Mar 2024 17:28:01 +0000 Received: (at 69745) by debbugs.gnu.org; 15 Mar 2024 17:27:35 +0000 Received: from localhost ([127.0.0.1]:53695 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rlBLD-0002M4-3p for submit@debbugs.gnu.org; Fri, 15 Mar 2024 13:27:35 -0400 Received: from sender4-pp-f112.zoho.com ([136.143.188.112]:27207) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rlBHO-0002Eu-SJ for 69745@debbugs.gnu.org; Fri, 15 Mar 2024 13:23:42 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1710523377; cv=none; d=zohomail.com; s=zohoarc; b=Lq4A+ziJllH7IKIuTVirHfi94sbZnSt7w6efxMmXuC4PJylTUZEGdMeYuOuX2FjrYg+p1fnDdjK5lo533yLWqbhrBr2WtKOy2z1uoX59jtNg/ngTlGb34GPPP89uv6oyL5VOd38Sg6kbQtglJZQpBkRlHUJamX3hsV40BZNyJUo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1710523377; h=Content-Type:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=eVVkXuMVx48GY1DeA0GbyTYtIFoKQFJLzN3oFsNU9Ns=; b=axtc3cvVfkkqj+w/EkNp7k0MC7xXWMUJXi2N1SyrDNcZrHjNajSHlm8GAIiv4I01RVudBxN6EELIuNzR+HGEUD8CnCGBXY+4lpIHuDVz0FXugJOu9+kq/zfAAZ06TwdiPhXg7xAmELQYSwPQAM9s0zus4uEI8WXAdHl/iSvBk1M= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1710523377; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Cc:Cc:Message-Id:Message-Id:In-Reply-To:References:Subject:Subject:MIME-Version:Content-Type:Reply-To; bh=eVVkXuMVx48GY1DeA0GbyTYtIFoKQFJLzN3oFsNU9Ns=; b=J2szl8cLPJ1KE77/wZjZCsbctsybuOR5FZrjtA50W3SrA9xZ3DJiwQdqBzPe45O/ vQ+pRsQr897kY+c2zoJ+SINjDylem4SJ7EziTigefdFsEH558JAxKt2tM7WHo8VGEFS VzBAaRuRSYDVzNWfjKQbqZF5pH3AhG5nP9yiZ6zU= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1710523375729200.16209540255284; Fri, 15 Mar 2024 10:22:55 -0700 (PDT) Date: Fri, 15 Mar 2024 18:22:55 +0100 From: Matt Message-Id: <18e43236053.ea8d2a62434521.1358079795129399231@excalamus.com> In-Reply-To: References: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="----=_Part_1428726_1091533694.1710523375699" Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail X-Zoho-Virus-Status: 1 X-Zoho-AV-Stamp: zmail-av-1.1.0/210.452.42 X-Spam-Score: -0.0 (/) X-Mailman-Approved-At: Fri, 15 Mar 2024 13:27:34 -0400 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 (-) ------=_Part_1428726_1091533694.1710523375699 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable ---- On Tue, 12 Mar 2024 13:59:58 +0100 Andreas Schwab wrote ---=20 > On M=C3=A4r 12 2024, Matt wrote: >=20 > > When edebug-print-length and edebug-print-level are nil, they default = to print-level and print-length. The docstrings currently say the opposite= , that edebug defaults to the print variables if non-nil. >=20 > That's not correct. The edebug-print-* variables, when non-nil, > override the corresponding print-* variables during printing (see > edebug-safe-prin1-to-string). When they are nil, they have no effect. >=20 > > (defcustom edebug-print-length 50 > > - "If non-nil, default value of `print-length' for printing results i= n Edebug." > > + "If nil, default value of `print-length' is used for printing resul= ts in Edebug." >=20 > That fails to say what happens if it is non-nil, which is the actual > relevant information. Thanks for taking the time to review this. =20 You are correct in the functioning. The problem is the current docstrings = are ambiguous. Consider the current description for 'edebug-print-length': "If non-nil, default value of =E2=80=98print-length=E2=80=99 for printing r= esults in Edebug." This has, at least, two possible interpretations: 1. "If non-nil, USE THE VALUE OF EDEBUG-PRINT-LENGTH FOR THE default value = of 'print-length' for printing results in Edebug." =20 2. "If non-nil, USE THE default value of 'print-length' for printing result= s in Edebug." =20 =20 As you point out, the first meaning is the intended one based on the implem= entation. I read it according to the second interpretation. Without getting hung up on why it's ambiguous, I hope I've made the case th= at it is ambiguous. I've updated the patch to use the same wording as 'print-length' and 'print= -level' which hopefully makes things clear. The current docstring felt it= necessary to explicitly mention "for printing results in Edebug" and I've = tried to preserve that in the suggested changes. -- Matt Trzcinski Emacs Org contributor (ob-shell) Learn more about Org mode at https://orgmode.org Support Org development at=C2=A0https://liberapay.com/org-mode ------=_Part_1428726_1091533694.1710523375699 Content-Type: application/octet-stream; name=v02-fix-incorrect-edebug-docstring.diff Content-Transfer-Encoding: 7bit X-ZM_AttachId: 139298161756990370 Content-Disposition: attachment; filename=v02-fix-incorrect-edebug-docstring.diff diff --git a/lisp/emacs-lisp/edebug.el b/lisp/emacs-lisp/edebug.el index 4c7dbb4ef8c..8be066d0f61 100644 --- a/lisp/emacs-lisp/edebug.el +++ b/lisp/emacs-lisp/edebug.el @@ -193,10 +193,12 @@ Use this with caution since it is not debugged." (defcustom edebug-print-length 50 - "If non-nil, default value of `print-length' for printing results in Edebug." + "Maximum length of list to print before abbreviating while in `edebug-mode'. +When nil, behave according to `print-length'." :type '(choice integer (const nil))) (defcustom edebug-print-level 50 - "If non-nil, default value of `print-level' for printing results in Edebug." + "Maximum depth of list nesting to print before abbreviating while in `edebug-mode'. +When nil, behave according to `print-level'." :type '(choice integer (const nil))) (defcustom edebug-print-circle t "If non-nil, default value of `print-circle' for printing results in Edebug." ------=_Part_1428726_1091533694.1710523375699-- From unknown Fri Sep 05 11:52:32 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Matt Subject: bug#69745: closed (Re: bug#69745: [PATCH] Fix incorrect Edebug docstrings) Message-ID: References: <868r2i78yr.fsf@gnu.org> <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> X-Gnu-PR-Message: they-closed 69745 X-Gnu-PR-Package: emacs X-Gnu-PR-Keywords: patch Reply-To: 69745@debbugs.gnu.org Date: Sat, 16 Mar 2024 10:45:01 +0000 Content-Type: multipart/mixed; boundary="----------=_1710585901-24795-1" This is a multi-part message in MIME format... ------------=_1710585901-24795-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #69745: [PATCH] Fix incorrect Edebug docstrings which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 69745@debbugs.gnu.org. --=20 69745: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D69745 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1710585901-24795-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 69745-done) by debbugs.gnu.org; 16 Mar 2024 10:44:29 +0000 Received: from localhost ([127.0.0.1]:54911 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rlRWf-0006Qo-5B for submit@debbugs.gnu.org; Sat, 16 Mar 2024 06:44:29 -0400 Received: from eggs.gnu.org ([209.51.188.92]:58892) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rlRWc-0006QT-Vq for 69745-done@debbugs.gnu.org; Sat, 16 Mar 2024 06:44:27 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rlRVw-0003Yv-5u; Sat, 16 Mar 2024 06:43:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=abpzncYOcKqjVSK9e+o5OToBR0qjvLxLWS/izowvLOs=; b=NN/zIoStzUH6Dzoz7s9X mtzggnNX0o3dzVtYAeq9T+28DtXWFnvNdr3eDiciHTeF+VGDmiQGMIhQWtekWkH83zwxvXz7WJgTh TLvjdrpST+2CnVIvrQlyyuTpRQWzqLP4OJ9eF14njzQ0QlCAIZsYpwdwPLil18YpueqJYCESwbxa3 vw4OwdodS5VBc1L18rYZ5uczKa0IG732V1xIQ5doBHbkSsIpJsFPHdVZ45kwf220qdeN38h+tHmh9 RD7wEoJ9qjIUuCClrsQIHl6wXRM88nKfL70y3a8FRZoldTCBAx5l6c1knAmqWJYy82jDZ+LkNSeX4 YSMzb5B61mJl6A==; Date: Sat, 16 Mar 2024 12:43:40 +0200 Message-Id: <868r2i78yr.fsf@gnu.org> From: Eli Zaretskii To: Matt In-Reply-To: <18e43236053.ea8d2a62434521.1358079795129399231@excalamus.com> (message from Matt on Fri, 15 Mar 2024 18:22:55 +0100) Subject: Re: bug#69745: [PATCH] Fix incorrect Edebug docstrings References: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> <18e43236053.ea8d2a62434521.1358079795129399231@excalamus.com> MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 69745-done Cc: 69745-done@debbugs.gnu.org, schwab@suse.de 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 (---) > Cc: 69745 <69745@debbugs.gnu.org> > Date: Fri, 15 Mar 2024 18:22:55 +0100 > From: Matt > > Thanks for taking the time to review this. > > You are correct in the functioning. The problem is the current docstrings are ambiguous. Consider the current description for 'edebug-print-length': > > "If non-nil, default value of ‘print-length’ for printing results in Edebug." > > This has, at least, two possible interpretations: > > 1. "If non-nil, USE THE VALUE OF EDEBUG-PRINT-LENGTH FOR THE default value of 'print-length' for printing results in Edebug." > 2. "If non-nil, USE THE default value of 'print-length' for printing results in Edebug." > > As you point out, the first meaning is the intended one based on the implementation. I read it according to the second interpretation. > > Without getting hung up on why it's ambiguous, I hope I've made the case that it is ambiguous. > > I've updated the patch to use the same wording as 'print-length' and 'print-level' which hopefully makes things clear. The current docstring felt it necessary to explicitly mention "for printing results in Edebug" and I've tried to preserve that in the suggested changes. Thanks, I installed a variant of this on the emacs-29 branch, and I'm therefore closing this bug. ------------=_1710585901-24795-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 12 Mar 2024 12:21:06 +0000 Received: from localhost ([127.0.0.1]:41990 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rk17x-0003xc-Eu for submit@debbugs.gnu.org; Tue, 12 Mar 2024 08:21:06 -0400 Received: from lists.gnu.org ([209.51.188.17]:47298) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rjyCd-0003ux-L2 for submit@debbugs.gnu.org; Tue, 12 Mar 2024 05:13:47 -0400 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 1rjyC4-00076l-QB for bug-gnu-emacs@gnu.org; Tue, 12 Mar 2024 05:13:08 -0400 Received: from sender4-pp-f112.zoho.com ([136.143.188.112]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rjyC3-00012x-13 for bug-gnu-emacs@gnu.org; Tue, 12 Mar 2024 05:13:08 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1710234782; cv=none; d=zohomail.com; s=zohoarc; b=Ys9Hh4NVIE+J2ZluJNP0WA2kBoVkwltrmKYcKCENbo3/7Kg3I7vZtpITlwPD1ZYhWXnlLP6Ht2pFRgWy1D+lC2jPjXvBYUIa0JP9SXVBJRnJZqjDjfNVwMB4U04xvjzYlt8f4UQqn5LZN/Z759qXj7L+nUXehosN7eLjjJ1AhAY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1710234782; h=Content-Type:Date:Date:From:From:MIME-Version:Message-ID:Subject:Subject:To:To:Message-Id:Reply-To:Cc; bh=0sjeLOdxMcLae2h4F3WqL45sc/WHuR6AF9X+L9oXr4U=; b=EADFvdkiuhIOwEqa+Tn4ilJ2mBU7LhgLbu6XTb8mQmo6yEoikaXVTwfzldmM3CDgYxNrjf0EYgL58ws5tmnY0vribhgmQUQM8Co7wGWN5CA+9CJ8psdBAzvM2FgqP/rzIhSxywK+RgGbqTcg2yPMi4IWfCfI0wUVC2dcey5kQ+E= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1710234782; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Message-Id:Message-Id:In-Reply-To:Subject:Subject:MIME-Version:Content-Type:Reply-To:Cc; bh=0sjeLOdxMcLae2h4F3WqL45sc/WHuR6AF9X+L9oXr4U=; b=gIR96VYskQgjRjit1QmV3KXqhPbGO/6Spe/p4ZoX8V5bHUjbdCLN5ZO5q9zrAvB1 K5Psj+AhkFALUlVcw9fd6mahteNg8nmfokVLG6Hskan66HZ05DF53ApeNCfrRhQqJyf wvyMMJCAe57EctHluHESQl9wp/DvH7WLchJ8mXb0= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1710234781371830.9519196074343; Tue, 12 Mar 2024 02:13:01 -0700 (PDT) Date: Tue, 12 Mar 2024 10:13:01 +0100 From: Matt To: "bug-gnu-emacs" Message-Id: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> In-Reply-To: Subject: [PATCH] Fix incorrect Edebug docstrings MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="----=_Part_755978_505512936.1710234781283" Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail X-Zoho-Virus-Status: 1 X-Zoho-AV-Stamp: zmail-av-1.1.0/210.162.90 Received-SPF: pass client-ip=136.143.188.112; envelope-from=matt@excalamus.com; helo=sender4-pp-f112.zoho.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.3 (-) X-Debbugs-Envelope-To: submit X-Mailman-Approved-At: Tue, 12 Mar 2024 08:21:03 -0400 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.3 (--) ------=_Part_755978_505512936.1710234781283 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hi, When edebug-print-length and edebug-print-level are nil, they default to pr= int-level and print-length. The docstrings currently say the opposite, tha= t edebug defaults to the print variables if non-nil. Thank you -- Matt Trzcinski Emacs Org contributor (ob-shell) Learn more about Org mode at https://orgmode.org Support Org development at=C2=A0https://liberapay.com/org-mode ------=_Part_755978_505512936.1710234781283 Content-Type: application/octet-stream; name=fix-incorrect-edebug-docstring.diff Content-Transfer-Encoding: 7bit X-ZM_AttachId: 139295275812830220 Content-Disposition: attachment; filename=fix-incorrect-edebug-docstring.diff diff --git a/lisp/emacs-lisp/edebug.el b/lisp/emacs-lisp/edebug.el index 4c7dbb4ef8c..a33593dca4c 100644 --- a/lisp/emacs-lisp/edebug.el +++ b/lisp/emacs-lisp/edebug.el @@ -193,10 +193,10 @@ Use this with caution since it is not debugged." (defcustom edebug-print-length 50 - "If non-nil, default value of `print-length' for printing results in Edebug." + "If nil, default value of `print-length' is used for printing results in Edebug." :type '(choice integer (const nil))) (defcustom edebug-print-level 50 - "If non-nil, default value of `print-level' for printing results in Edebug." + "If nil, default value of `print-level' is used for printing results in Edebug." :type '(choice integer (const nil))) (defcustom edebug-print-circle t "If non-nil, default value of `print-circle' for printing results in Edebug." ------=_Part_755978_505512936.1710234781283-- ------------=_1710585901-24795-1--