From unknown Mon Aug 18 18:02:25 2025 X-Loop: help-debbugs@gnu.org Subject: bug#68002: 30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name Resent-From: Ihor Radchenko Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 24 Dec 2023 10:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 68002 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 68002@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.17034141815480 (code B ref -1); Sun, 24 Dec 2023 10:37:02 +0000 Received: (at submit) by debbugs.gnu.org; 24 Dec 2023 10:36:21 +0000 Received: from localhost ([127.0.0.1]:51720 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rHLqH-0001QK-0I for submit@debbugs.gnu.org; Sun, 24 Dec 2023 05:36:21 -0500 Received: from lists.gnu.org ([2001:470:142::17]:59796) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rHLqC-0001Pr-8k for submit@debbugs.gnu.org; Sun, 24 Dec 2023 05:36:16 -0500 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 1rHLpy-0007ZL-3K for bug-gnu-emacs@gnu.org; Sun, 24 Dec 2023 05:36:03 -0500 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rHLpu-00009f-Np for bug-gnu-emacs@gnu.org; Sun, 24 Dec 2023 05:36:01 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 348E4240101 for ; Sun, 24 Dec 2023 11:35:56 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1703414156; bh=DbCYiET4c8wlpi6WlgkxTnmkOR+qm4K6GcuwyLTklYw=; h=From:To:Subject:Date:Message-ID:MIME-Version:From; b=AU6ub6VZQADeDP/eyTEj84oTxptWkJW/UuL+Qti0MXgxcxPu9RwkYB9uCA+6mQNRA 5TMC4d2+kCANGn+bX+j2kzNH4lqG0DmFu+DmDgyJlmFvjXxV9KdMQBlsdqt9ozuRQ8 vamRSCLlRFdbhbcNUeHo/Lx8JPXiW7o6rwWhGvLSuqxdgd1m4UZHmNVKxww9LvM0HT 3UYdCD3lGNpekjvnooPkH87jYFqhnbxtj3nahYewREdguE/kfekAm8E2N0+UkPetly +dpYsyz+6n6yeidYX+3cgDJyR5Wpmz0/BZBnd/zfjSKuSfzySXey61fbxGbICQyjN3 2gpen+G2OpfEQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4SycrW5Nldz6trs for ; Sun, 24 Dec 2023 11:35:55 +0100 (CET) From: Ihor Radchenko Date: Sun, 24 Dec 2023 10:39:09 +0000 Message-ID: <871qbbdgvm.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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_MED=-2.3, RCVD_IN_MSPIKE_H5=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.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: -0.0 (/) Hi, I have the following docstring: (defvar org-element--cache-interrupt-C-g-count 0 "Current number of `org-element--cache-sync' calls. See `org-element--cache-interrupt-C-g'.") When I run M-x checkdoc, I am getting Keycode C-g embedded in doc string. Use \\ & \\[command] instead Which is clearly false-positive. May this be fixed? In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.38, cairo version 1.18.0) of 2023-12-21 built on localhost Repository revision: 6161f72efbf6625f60bf7f7d28d6c39a26e94a51 Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12101009 System Description: Gentoo Linux Configured using: 'configure --with-native-compilation' -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at From unknown Mon Aug 18 18:02:25 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: Ihor Radchenko Subject: bug#68002: closed (Re: bug#68002: 30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name) Message-ID: References: <871qbbdgvm.fsf@localhost> X-Gnu-PR-Message: they-closed 68002 X-Gnu-PR-Package: emacs Reply-To: 68002@debbugs.gnu.org Date: Sun, 24 Dec 2023 13:30:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1703424602-4965-1" This is a multi-part message in MIME format... ------------=_1703424602-4965-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #68002: 30.0.50; checkdoc.el: False positive when a quote variable contains= "C-g" in its name 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 68002@debbugs.gnu.org. --=20 68002: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D68002 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1703424602-4965-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 68002-done) by debbugs.gnu.org; 24 Dec 2023 13:29:54 +0000 Received: from localhost ([127.0.0.1]:51808 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rHOYE-0001HX-71 for submit@debbugs.gnu.org; Sun, 24 Dec 2023 08:29:54 -0500 Received: from mail-ed1-x52c.google.com ([2a00:1450:4864:20::52c]:53555) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rHOYA-0001HG-Kj for 68002-done@debbugs.gnu.org; Sun, 24 Dec 2023 08:29:52 -0500 Received: by mail-ed1-x52c.google.com with SMTP id 4fb4d7f45d1cf-5537114380bso2560335a12.3 for <68002-done@debbugs.gnu.org>; Sun, 24 Dec 2023 05:29:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1703424578; x=1704029378; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :from:to:cc:subject:date:message-id:reply-to; bh=Y0ngx6NAD4Z+9NH/s9+SPiMFfBn4WIV/pYU13/NYAwU=; b=mGWBcyWZJZnHZJdKUHnGxpWU/VeNb9k9IlEJonfBmkY8nw6q+cb0gLrG4NkQxIJDog MRfTFCiSalSpk2FToLoxyl54dzfuUh8puCcmSk5eMkAD8tNZX4hqKzIRpE7OdKBpaYoB G6qfmLlXj975HPL/0cp6SmRPtyJAZ3wTizuvscXhmP/ePuqs9sHe2FBoJRk2hk/lHJou ZKWJSntnGNuHc3S+Ax4XGyLCRvYa8VuV9+UlKwqy0ZHtqiQ7xLVQzhW9EWpPzBxTgs5m zML4KZfHnZfOnzGnakKijn5lxUwVwo53Y2WF/Al0jZ/SYuwSeDNQiND9cpVuJyNi38cO v4og== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1703424578; x=1704029378; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=Y0ngx6NAD4Z+9NH/s9+SPiMFfBn4WIV/pYU13/NYAwU=; b=O5e46K4gI4nySej7bFliKDQzGhgkWa+VZ9eAkR6xw3hFjB3ydZLmr4qf1HKFq6/LeT XPq6bPW4pKeXZrK51fm5KBjlNdeEYXSOatGrAZ5TfKnU+6AOAPOQFyEZ09St2aE4K31J gc3q6/LCopfkG+F/54hcLdw6yVBc+mHaqdyDeYY6bvHNFokPgf26Fk9DBSjHk8R5p14M wJiyNJWpyOJThWdfNmpE2anr+6KCHDJbIS7NjG8KuusGH6ZubhDUE3g31UWARI4JvfKp FMz/63gGpEk1BYMinRKndCGu+fVQ+44nzjH4o4C2zpvAgHWgQyCsPWIdGpBkVpqlN6TL qIkA== X-Gm-Message-State: AOJu0Yz5PSbl2x/OIe4afvdmxRrnxoX44oaZbxayqwjcodVVVVNEXR6+ m0+e+tiTiTmJy35cTJ16nTvJNyyqdHlhGGyA3aM= X-Google-Smtp-Source: AGHT+IGP+JI0AamQX0Y/K7ZOf1ZXAXFyMCyDys271MLFr/g8KNPiTKfGJcCX3GtcbG2iWumnbjHrRyUC91JK2eRA26E= X-Received: by 2002:a50:9e87:0:b0:554:242f:2ad3 with SMTP id a7-20020a509e87000000b00554242f2ad3mr3346633edf.48.1703424578431; Sun, 24 Dec 2023 05:29:38 -0800 (PST) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sun, 24 Dec 2023 05:29:37 -0800 From: Stefan Kangas In-Reply-To: <871qbbdgvm.fsf@localhost> References: <871qbbdgvm.fsf@localhost> MIME-Version: 1.0 Date: Sun, 24 Dec 2023 05:29:37 -0800 Message-ID: Subject: Re: bug#68002: 30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name To: Ihor Radchenko , 68002-done@debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 68002-done 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 (-) Version: 30.1 Ihor Radchenko writes: > I have the following docstring: > > (defvar org-element--cache-interrupt-C-g-count 0 > "Current number of `org-element--cache-sync' calls. > See `org-element--cache-interrupt-C-g'.") > > When I run M-x checkdoc, I am getting > > Keycode C-g embedded in doc string. Use \\ & \\[command] instead > > Which is clearly false-positive. > > May this be fixed? Thanks for the bug report! This should now be fixed on master. ------------=_1703424602-4965-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 24 Dec 2023 10:36:21 +0000 Received: from localhost ([127.0.0.1]:51720 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rHLqH-0001QK-0I for submit@debbugs.gnu.org; Sun, 24 Dec 2023 05:36:21 -0500 Received: from lists.gnu.org ([2001:470:142::17]:59796) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rHLqC-0001Pr-8k for submit@debbugs.gnu.org; Sun, 24 Dec 2023 05:36:16 -0500 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 1rHLpy-0007ZL-3K for bug-gnu-emacs@gnu.org; Sun, 24 Dec 2023 05:36:03 -0500 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rHLpu-00009f-Np for bug-gnu-emacs@gnu.org; Sun, 24 Dec 2023 05:36:01 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 348E4240101 for ; Sun, 24 Dec 2023 11:35:56 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1703414156; bh=DbCYiET4c8wlpi6WlgkxTnmkOR+qm4K6GcuwyLTklYw=; h=From:To:Subject:Date:Message-ID:MIME-Version:From; b=AU6ub6VZQADeDP/eyTEj84oTxptWkJW/UuL+Qti0MXgxcxPu9RwkYB9uCA+6mQNRA 5TMC4d2+kCANGn+bX+j2kzNH4lqG0DmFu+DmDgyJlmFvjXxV9KdMQBlsdqt9ozuRQ8 vamRSCLlRFdbhbcNUeHo/Lx8JPXiW7o6rwWhGvLSuqxdgd1m4UZHmNVKxww9LvM0HT 3UYdCD3lGNpekjvnooPkH87jYFqhnbxtj3nahYewREdguE/kfekAm8E2N0+UkPetly +dpYsyz+6n6yeidYX+3cgDJyR5Wpmz0/BZBnd/zfjSKuSfzySXey61fbxGbICQyjN3 2gpen+G2OpfEQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4SycrW5Nldz6trs for ; Sun, 24 Dec 2023 11:35:55 +0100 (CET) From: Ihor Radchenko To: bug-gnu-emacs@gnu.org Subject: 30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name X-Debbugs-Cc: Date: Sun, 24 Dec 2023 10:39:09 +0000 Message-ID: <871qbbdgvm.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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_MED=-2.3, RCVD_IN_MSPIKE_H5=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.0 (+) 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: -0.0 (/) Hi, I have the following docstring: (defvar org-element--cache-interrupt-C-g-count 0 "Current number of `org-element--cache-sync' calls. See `org-element--cache-interrupt-C-g'.") When I run M-x checkdoc, I am getting Keycode C-g embedded in doc string. Use \\ & \\[command] instead Which is clearly false-positive. May this be fixed? In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.38, cairo version 1.18.0) of 2023-12-21 built on localhost Repository revision: 6161f72efbf6625f60bf7f7d28d6c39a26e94a51 Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12101009 System Description: Gentoo Linux Configured using: 'configure --with-native-compilation' -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at ------------=_1703424602-4965-1--