From debbugs-submit-bounces@debbugs.gnu.org Thu Mar 20 18:27:39 2025 Received: (at submit) by debbugs.gnu.org; 20 Mar 2025 22:27:40 +0000 Received: from localhost ([127.0.0.1]:59416 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tvOMU-00040V-Rv for submit@debbugs.gnu.org; Thu, 20 Mar 2025 18:27:39 -0400 Received: from lists.gnu.org ([2001:470:142::17]:48044) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tvOMN-0003yh-Rh for submit@debbugs.gnu.org; Thu, 20 Mar 2025 18:27:35 -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 1tvOMC-0001UK-18 for bug-gnu-emacs@gnu.org; Thu, 20 Mar 2025 18:27:20 -0400 Received: from out-185.mta0.migadu.com ([2001:41d0:1004:224b::b9]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tvOM1-0003LA-NI for bug-gnu-emacs@gnu.org; Thu, 20 Mar 2025 18:27:19 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1742509622; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type; bh=W80Ra9ZEpCQZ36+cMJnU5aE+OGkKPSMNwA+1XKeWS8Y=; b=KT4WKtpFIz8UOlFVh6F5Y3ChRKoPW93nNUwLL3YH3BKt/siGIO+/DvTENF+alnWQgu5/GQ 3sbC7d7wTD1Wx3io4xDq6+Ab4SDLEYY5isa+52KgXxapBvBo8vPAZS4+LbusOuBhXE0c8z FPaWe1OGEpg9bIzk2XlhBbJmpNpfYGiosJAyJxo+X2tuM74n/EBt3B8AN/qbEu4dNLg4ML +wn17pqe5NTpGPfUPLp5QNGq/lx68IB84L8iukGmxjtXnZUqruYZi+5QOoPL+S8ejFCNAT G4uvyNAoyN//3WVcr8/M6hNeX8yKn+VeTaN5BnnEynD735Qr5YTYDkjRmza35Q== From: Jeremy Bryant To: bug-gnu-emacs@gnu.org, Pip Cet , Gerd =?utf-8?Q?M=C3=B6llmann?= , Helmut Eller Subject: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions Date: Thu, 20 Mar 2025 22:27:00 +0000 Message-ID: <87bjtvwd6z.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:1004:224b::b9; envelope-from=jb@jeremybryant.net; helo=out-185.mta0.migadu.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, SPF_HELO_PASS=-0.001, T_SPF_TEMPERROR=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 0.9 (/) 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.1 (/) --=-=-= Content-Type: text/plain Pip, Gerd, Helmut, Here is a patch with some checkdoc fixes for igc.el, with proposed docstrings for interactive functions and some variables. WDYT? --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-igc.el-checkdox-fixes-for-interactiv.patch >From e803743e318260b82edc5838318ca5b80e33c45b Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Thu, 20 Mar 2025 22:19:33 +0000 Subject: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions Add docstring for interactive functions: (igc-snapshot) (igc-display-diff) (igc-display-a) (igc-display-b) (igc--roots-a) (igc--roots-b) (igc-roots-display-diff) (igc-roots-display-a) (igc-roots-display-b) (igc--roots-snapshot) (igc-stop-collecting-stats) Add docstring for variables: (igc--a) (igc--b) (igc--display-mode) (igc-stats-time-format) --- lisp/emacs-lisp/igc.el | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/lisp/emacs-lisp/igc.el b/lisp/emacs-lisp/igc.el index e9d897f9f64..2d69585b729 100644 --- a/lisp/emacs-lisp/igc.el +++ b/lisp/emacs-lisp/igc.el @@ -36,11 +36,15 @@ igc--diff when (and n1 n2 (/= n1 n2)) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--a nil) -(defvar igc--b nil) -(defvar igc--display-mode 'a) +(defvar igc--a nil + "IGC snapshot A. Used for debugging.") +(defvar igc--b nil + "IGC snapshot B. Used for debugging.") +(defvar igc--display-mode 'a + "IGC stats current snapshot, 'a or 'b.") (defun igc-snapshot () + "Take snapshot A or B depending on igc--display-mode." (interactive) (if (eq igc--display-mode 'a) (setq igc--a (igc-info)) @@ -54,16 +58,20 @@ igc--info-to-display (b igc--b))) (defun igc-display-diff () + "Display the difference between IGC snapshots A-B. +Used for debugging." (interactive) (setq igc--display-mode 'diff) (igc-stats)) (defun igc-display-a () + "Display IGC stats snapshot A from igc--roots." (interactive) (setq igc--display-mode 'a) (igc-stats)) (defun igc-display-b () + "Display IGC stats snapshot A from igc--roots." (interactive) (setq igc--display-mode 'b) (igc-stats)) @@ -174,21 +182,26 @@ igc--roots-diff unless (= n1 n2) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--roots-a nil) -(defvar igc--roots-b nil) +(defvar igc--roots-a nil + "IGC roots snapshot A. Used for debugging statistics.") +(defvar igc--roots-b nil + "IGC roots snapshot B. Used for debugging statistics.") (defvar igc--roots-display-mode 'a) (defun igc-roots-display-diff () +"Display the difference between IGC roots snapshots A and B." (interactive) (setq igc--roots-display-mode 'diff) (igc-roots-stats)) (defun igc-roots-display-a () + "Display IGC roots for snapshot A." (interactive) (setq igc--roots-display-mode 'a) (igc-roots-stats)) (defun igc-roots-display-b () + "Display IGC roots for snapshot B." (interactive) (setq igc--roots-display-mode 'b) (igc-roots-stats)) @@ -209,6 +222,7 @@ igc--roots-info (cl-loop for i being the hash-values of h collect i))) (defun igc--roots-snapshot () + "Display roots snapshots a or b." (interactive) (if (eq igc--roots-display-mode 'a) (setq igc--roots-a (igc--roots-info)) @@ -282,6 +296,7 @@ igc--sqlite ;;;###autoload (defun igc-stop-collecting-stats () + "Stop collecting IGC stats." (interactive) (when igc--collect-timer (cancel-timer igc--collect-timer) @@ -290,7 +305,8 @@ igc-stop-collecting-stats (sqlite-close igc--sqlite) (setq igc--sqlite nil)))) -(defvar igc-stats-time-format "%T.%3N") +(defvar igc-stats-time-format "%T.%3N" + "Time format when exporting IGC stats, e.g. to csv or sqlite.") (defun igc--collect-stats-csv () (let ((buffer (get-file-buffer igc--collect-file))) -- 2.47.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Sat Mar 22 07:41:10 2025 Received: (at 77142) by debbugs.gnu.org; 22 Mar 2025 11:41:10 +0000 Received: from localhost ([127.0.0.1]:41246 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tvxDy-0002lN-46 for submit@debbugs.gnu.org; Sat, 22 Mar 2025 07:41:10 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39250) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tvxDw-0002lA-Oq for 77142@debbugs.gnu.org; Sat, 22 Mar 2025 07:41:09 -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 1tvxDq-0000fq-5K; Sat, 22 Mar 2025 07:41:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=AfTz+go41gk0r4dRWPSLPuLs032XQ+uP8bz1TSX5zYg=; b=i5T8ZGclmmqW xDC1mqdZ3/oNclZRNM48YSha/x1Rv62NBewvBSl1zzebJu1TfmjmRuL70GCqdKP+YeWr+yloKBRFM tZOLAybdTX4kUOhK+OfHMsiypK+BWb9nbRizszzMkpskFNrS7MxJebZ+KYehg9r7KgZa07kncom42 yASQ83TKri/F0TK9glef45AWzH+3cSGBKw0AqRaQCK1Gm3u7U4joU1zSkLjJKXVw8vq5QsqhwMXUD Ts0JD8RfBR2v17tQgQznVZrVUldXDgDimNcmOacixtxnuyKyR4MLjQnnapCl8VA/zz+RyovarP+WI fNBuCopKEn6rN0f9DJ8PmA==; Date: Sat, 22 Mar 2025 13:40:58 +0200 Message-Id: <86bjttjnsl.fsf@gnu.org> From: Eli Zaretskii To: Jeremy Bryant In-Reply-To: <87bjtvwd6z.fsf@jeremybryant.net> (bug-gnu-emacs@gnu.org) Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions References: <87bjtvwd6z.fsf@jeremybryant.net> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, pipcet@protonmail.com, eller.helmut@gmail.com, 77142@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 (---) > Date: Thu, 20 Mar 2025 22:27:00 +0000 > From: Jeremy Bryant via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > Here is a patch with some checkdoc fixes for igc.el, with proposed > docstrings for interactive functions and some variables. > > WDYT? It triggers the following warning from byte-compiler: ELC emacs-lisp/igc.elc In toplevel form: emacs-lisp/igc.el:43:9: Warning: defvar `igc--display-mode' docstring has wrong usage of unescaped single quotes (use \=' or different quoting such as `...') From debbugs-submit-bounces@debbugs.gnu.org Sat Mar 22 10:55:20 2025 Received: (at 77142) by debbugs.gnu.org; 22 Mar 2025 14:55:20 +0000 Received: from localhost ([127.0.0.1]:44545 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tw0Fr-00056L-SC for submit@debbugs.gnu.org; Sat, 22 Mar 2025 10:55:20 -0400 Received: from out-188.mta1.migadu.com ([95.215.58.188]:11237) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tw0Fp-00050a-2P for 77142@debbugs.gnu.org; Sat, 22 Mar 2025 10:55:18 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1742655310; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=B52wYvmEF+tDbxbQEuLcpgKE9tsNJfO9Z20ZyM8YxQw=; b=avXX4DkvI/mp5DkLg7tEZD4ekgZIMTIGcdPatU5x+S6vWxW8qGhO83lOzYZGHDxsEb2aKG CsnnF/7MOFsKqvS9FIE72KpqlNl0g5RKXWlsbLjTUIl/PQD704YkzMRTOr50Xek9Q8mP4E ySP79VuI01OI7eqclm2jqlh8Y5MIn8eTT1opDvhZ2rjf9fi5QEUQjxvgXUOihYVy1jZExy bqaiPedv7r7CCUMvJ1u3q903Y/VMzfBlltSvZ7x/tYO2LQnv7H1g9/n5yC5Z0gG+BZpR/P N1AVSQa0PSbJ7Qd+6S+T8PhVGKXsjlq5wYCSY1uaUnY62mFEhlvkirfDzdpZww== From: Jeremy Bryant To: Eli Zaretskii Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions In-Reply-To: <86bjttjnsl.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 22 Mar 2025 13:40:58 +0200") References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> Date: Sat, 22 Mar 2025 14:55:02 +0000 Message-ID: <874izluncp.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: text/plain X-Migadu-Flow: FLOW_OUT X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, pipcet@protonmail.com, eller.helmut@gmail.com, 77142@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.7 (-) Eli Zaretskii writes: >> Date: Thu, 20 Mar 2025 22:27:00 +0000 >> From: Jeremy Bryant via "Bug reports for GNU Emacs, >> the Swiss army knife of text editors" >> >> Here is a patch with some checkdoc fixes for igc.el, with proposed >> docstrings for interactive functions and some variables. >> >> WDYT? > > It triggers the following warning from byte-compiler: > > ELC emacs-lisp/igc.elc > > In toplevel form: > emacs-lisp/igc.el:43:9: Warning: defvar `igc--display-mode' docstring has wrong usage of unescaped single quotes (use \=' or different quoting such as `...') OK I will fix it and send a revised patch. From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 08 14:30:35 2025 Received: (at 77142) by debbugs.gnu.org; 8 Apr 2025 18:30:35 +0000 Received: from localhost ([127.0.0.1]:35429 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u2DiU-0004PZ-PU for submit@debbugs.gnu.org; Tue, 08 Apr 2025 14:30:35 -0400 Received: from out-185.mta0.migadu.com ([91.218.175.185]:61371) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u2DiR-0004P4-Di for 77142@debbugs.gnu.org; Tue, 08 Apr 2025 14:30:32 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1744137024; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=25l8KkMaGUOuZhpm4W3itJJu6dIN/p/lzpb3RlGHlMc=; b=HkXPulsBt/sZYeei7l0tTo9NVuxFzSRpadd1YfmkYo0vUs7ycn3br9bsbWk4S8YB4O7b2K TYu2tIC4dlDVlgTK+DvXnb/gYxyc5hTQYU1PU9uAgR+YNdCILWN9RHI/H8I0W1Nk5SFak3 u003VT2LYiDv2mO9L56xJ0ACaU0cR1Y+HXvr7VX0suPyfXdk2E7vCy4lF6vzR0xhKC6oco efrL0/MRboqpt6OBf2LYP4az0ErprgLVPLs9joL8reLFqB9Mgf0d5IwHy4lU1duHbnf17p QV1TZV1WDVn99a7coyURdbtDigiPGM/JKG9VHiG7rJDji76RblYRZaQ1wOg3Mw== From: Jeremy Bryant To: Eli Zaretskii Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions In-Reply-To: <874izluncp.fsf@jeremybryant.net> (Jeremy Bryant's message of "Sat, 22 Mar 2025 14:55:02 +0000") References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> <874izluncp.fsf@jeremybryant.net> Date: Tue, 08 Apr 2025 19:30:22 +0100 Message-ID: <871pu2sdz5.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, pipcet@protonmail.com, eller.helmut@gmail.com, 77142@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.7 (-) --=-=-= Content-Type: text/plain Jeremy Bryant writes: > Eli Zaretskii writes: > >>> Date: Thu, 20 Mar 2025 22:27:00 +0000 >>> From: Jeremy Bryant via "Bug reports for GNU Emacs, >>> the Swiss army knife of text editors" >>> >>> Here is a patch with some checkdoc fixes for igc.el, with proposed >>> docstrings for interactive functions and some variables. >>> >>> WDYT? >> >> It triggers the following warning from byte-compiler: >> >> ELC emacs-lisp/igc.elc >> >> In toplevel form: >> emacs-lisp/igc.el:43:9: Warning: defvar `igc--display-mode' docstring has wrong usage of unescaped single quotes (use \=' or different quoting such as `...') > > OK I will fix it and send a revised patch. Revised patch attached. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-igc.el-checkdox-fixes-for-interactiv.patch >From 3fefd7a9774a825af6497fa52ef22caf353e9044 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Thu, 20 Mar 2025 22:19:33 +0000 Subject: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions Add docstring for interactive functions: (igc-snapshot) (igc-display-diff) (igc-display-a) (igc-display-b) (igc--roots-a) (igc--roots-b) (igc-roots-display-diff) (igc-roots-display-a) (igc-roots-display-b) (igc--roots-snapshot) (igc-stop-collecting-stats) Add docstring for variables: (igc--a) (igc--b) (igc--display-mode) (igc-stats-time-format) --- lisp/emacs-lisp/igc.el | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/lisp/emacs-lisp/igc.el b/lisp/emacs-lisp/igc.el index e9d897f9f64..85027a4c8d0 100644 --- a/lisp/emacs-lisp/igc.el +++ b/lisp/emacs-lisp/igc.el @@ -36,11 +36,15 @@ igc--diff when (and n1 n2 (/= n1 n2)) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--a nil) -(defvar igc--b nil) -(defvar igc--display-mode 'a) +(defvar igc--a nil + "IGC snapshot A. Used for debugging.") +(defvar igc--b nil + "IGC snapshot B. Used for debugging.") +(defvar igc--display-mode 'a + "IGC stats current snapshot, \='a or \='b.") (defun igc-snapshot () + "Take snapshot A or B depending on igc--display-mode." (interactive) (if (eq igc--display-mode 'a) (setq igc--a (igc-info)) @@ -54,16 +58,20 @@ igc--info-to-display (b igc--b))) (defun igc-display-diff () + "Display the difference between IGC snapshots A-B. +Used for debugging." (interactive) (setq igc--display-mode 'diff) (igc-stats)) (defun igc-display-a () + "Display IGC stats snapshot A from igc--roots." (interactive) (setq igc--display-mode 'a) (igc-stats)) (defun igc-display-b () + "Display IGC stats snapshot A from igc--roots." (interactive) (setq igc--display-mode 'b) (igc-stats)) @@ -174,21 +182,26 @@ igc--roots-diff unless (= n1 n2) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--roots-a nil) -(defvar igc--roots-b nil) +(defvar igc--roots-a nil + "IGC roots snapshot A. Used for debugging statistics.") +(defvar igc--roots-b nil + "IGC roots snapshot B. Used for debugging statistics.") (defvar igc--roots-display-mode 'a) (defun igc-roots-display-diff () +"Display the difference between IGC roots snapshots A and B." (interactive) (setq igc--roots-display-mode 'diff) (igc-roots-stats)) (defun igc-roots-display-a () + "Display IGC roots for snapshot A." (interactive) (setq igc--roots-display-mode 'a) (igc-roots-stats)) (defun igc-roots-display-b () + "Display IGC roots for snapshot B." (interactive) (setq igc--roots-display-mode 'b) (igc-roots-stats)) @@ -209,6 +222,7 @@ igc--roots-info (cl-loop for i being the hash-values of h collect i))) (defun igc--roots-snapshot () + "Display roots snapshots a or b." (interactive) (if (eq igc--roots-display-mode 'a) (setq igc--roots-a (igc--roots-info)) @@ -282,6 +296,7 @@ igc--sqlite ;;;###autoload (defun igc-stop-collecting-stats () + "Stop collecting IGC stats." (interactive) (when igc--collect-timer (cancel-timer igc--collect-timer) @@ -290,7 +305,8 @@ igc-stop-collecting-stats (sqlite-close igc--sqlite) (setq igc--sqlite nil)))) -(defvar igc-stats-time-format "%T.%3N") +(defvar igc-stats-time-format "%T.%3N" + "Time format when exporting IGC stats, e.g. to csv or sqlite.") (defun igc--collect-stats-csv () (let ((buffer (get-file-buffer igc--collect-file))) -- 2.47.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 08 14:43:04 2025 Received: (at 77142) by debbugs.gnu.org; 8 Apr 2025 18:43:05 +0000 Received: from localhost ([127.0.0.1]:35480 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u2Dua-00051a-HW for submit@debbugs.gnu.org; Tue, 08 Apr 2025 14:43:04 -0400 Received: from mail-10628.protonmail.ch ([79.135.106.28]:53229) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u2DuW-00050z-IG for 77142@debbugs.gnu.org; Tue, 08 Apr 2025 14:43:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1744137773; x=1744396973; bh=TOWDoQFtayCL1ngEJllTrfx/BuANWrGswPrx8ARBPKE=; h=Date:To:From:Cc:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector:List-Unsubscribe:List-Unsubscribe-Post; b=uohyyNQ4Gp6p1p55k1ny8ZNhdccBtbn3VCUX4CwzGod4RlULzmzIFSy8FAM6GAHfE Jgc1o/bMsxf/Lgp+P5Ubx3NRucroJaildErNvzurEuy0/Z/ApSb8EmcL4LbDgR/9dg 4n2PpQALmNUiDT1oIlxUpxnPxSqA+rnXO6idpy4GP1U6eKJo5bsofhr9pyXambIxT1 mQrJy2xVod3UvXAF/b11PwBeJlZS2Jf4TCTzvuq/z0ox0nBtEfVKAIui0Z3E52jim+ 7Xxyz+V//ftrlsiIpuGXIS+MJEfR++NegEFoXaiThz4bAmzB6hRqg6ZF3Yrc+CZkge SoV2kggP7jRkw== Date: Tue, 08 Apr 2025 18:42:47 +0000 To: Jeremy Bryant From: Pip Cet Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions Message-ID: <87ldsasdeq.fsf@protonmail.com> In-Reply-To: <871pu2sdz5.fsf@jeremybryant.net> References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> <874izluncp.fsf@jeremybryant.net> <871pu2sdz5.fsf@jeremybryant.net> Feedback-ID: 112775352:user:proton X-Pm-Message-ID: 320908fbfc93361cb8f61c88ebfc9735bf94ca31 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, Eli Zaretskii , eller.helmut@gmail.com, 77142@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 (-) "Jeremy Bryant" writes: > Jeremy Bryant writes: > >> Eli Zaretskii writes: >> >>>> Date: Thu, 20 Mar 2025 22:27:00 +0000 >>>> From: Jeremy Bryant via "Bug reports for GNU Emacs, >>>> the Swiss army knife of text editors" >>>> >>>> Here is a patch with some checkdoc fixes for igc.el, with proposed >>>> docstrings for interactive functions and some variables. >>>> >>>> WDYT? >>> >>> It triggers the following warning from byte-compiler: >>> >>> ELC emacs-lisp/igc.elc >>> >>> In toplevel form: >>> emacs-lisp/igc.el:43:9: Warning: defvar `igc--display-mode' docstring= has wrong usage of unescaped single quotes (use \=3D' or different quoting= such as `...') >> >> OK I will fix it and send a revised patch. > > Revised patch attached. There are some differences between the docstrings for igc-stats and igc-roots. I think the igc-roots version is fine, and the igc-stats docstrings should be adjusted accordingly. > @@ -54,16 +58,20 @@ igc--info-to-display > (b igc--b))) > > (defun igc-display-diff () > + "Display the difference between IGC snapshots A-B. > +Used for debugging." I prefer "A and B", because we already spell out that we're calculating the difference. As in the docstring for igc-roots-display-diff, I'd also omit the "Used for debugging." > (interactive) > (setq igc--display-mode 'diff) > (igc-stats)) > > (defun igc-display-a () > + "Display IGC stats snapshot A from igc--roots." I'm not sure about the "from igc--roots" part. ... "in igc-stats-mode" would work, but we can also omit it entirely. Pip From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 08 17:13:03 2025 Received: (at 77142) by debbugs.gnu.org; 8 Apr 2025 21:13:03 +0000 Received: from localhost ([127.0.0.1]:35811 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u2GFj-0007F4-0r for submit@debbugs.gnu.org; Tue, 08 Apr 2025 17:13:03 -0400 Received: from out-186.mta0.migadu.com ([2001:41d0:1004:224b::ba]:10795) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u2GFg-0007EU-Nl for 77142@debbugs.gnu.org; Tue, 08 Apr 2025 17:13:01 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1744146773; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=ZW5cObfuGNSoxsHN4T5SHHjuEIjMcrOoKEYsH+7s0g4=; b=N28ceNfA7dZCcUxHHdxBc8oGzk+yx6eqHCGMndQoHj+oQ7Q2uX5F91sHV9LsOlyR9aWveu UFxUNV98qUFIVyBT6w+2g7a3p7d6T0BAmMlz3OsoC8Fou7Q7aWosB/dPd38B1Q6GlC1cr/ QsjIT4m70fdAhBXOkz1xQJ78IypdDdCdXSvQYb8oTeg3sUKMiEwcoBNP3pt4snlcrCOlHD H/3Kl2yUpjqgKEpMCH4lmXQhc7F5Kg/A+Lgdx1AnR3rVegiG4R8xuDRIdx08dnIZePRJa2 g15tk5avb+EpvsyDk4AoCbaYG9zTmXDJbfrju8iL//lFMV/4uCR8n+eTZYb2ZQ== From: Jeremy Bryant To: Pip Cet Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions In-Reply-To: <87ldsasdeq.fsf@protonmail.com> (Pip Cet's message of "Tue, 08 Apr 2025 18:42:47 +0000") References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> <874izluncp.fsf@jeremybryant.net> <871pu2sdz5.fsf@jeremybryant.net> <87ldsasdeq.fsf@protonmail.com> Date: Tue, 08 Apr 2025 22:12:51 +0100 Message-ID: <87plhmqrvw.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, Eli Zaretskii , eller.helmut@gmail.com, 77142@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 (-) --=-=-= Content-Type: text/plain Pip Cet writes: > "Jeremy Bryant" writes: > >> Revised patch attached. New partially revised patch attached with comments below. > There are some differences between the docstrings for igc-stats and > igc-roots. I think the igc-roots version is fine, and the igc-stats > docstrings should be adjusted accordingly. What do you mean? Is it igc-roots-stats? If so, what changes? >> (defun igc-display-diff () >> + "Display the difference between IGC snapshots A-B. >> +Used for debugging." > > I prefer "A and B", because we already spell out that we're calculating > the difference. As in the docstring for igc-roots-display-diff, I'd also > omit the "Used for debugging." OK, done. > >> (interactive) >> (setq igc--display-mode 'diff) >> (igc-stats)) >> >> (defun igc-display-a () >> + "Display IGC stats snapshot A from igc--roots." > > I'm not sure about the "from igc--roots" part. ... "in igc-stats-mode" > would work, but we can also omit it entirely. OK, revision attached. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-igc.el-checkdox-fixes-for-interactiv.patch >From 5f315d6b197e0e13ff2829837d13b49dc1afa11e Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Thu, 20 Mar 2025 22:19:33 +0000 Subject: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions Add docstring for interactive functions: (igc-snapshot) (igc-display-diff) (igc-display-a) (igc-display-b) (igc--roots-a) (igc--roots-b) (igc-roots-display-diff) (igc-roots-display-a) (igc-roots-display-b) (igc--roots-snapshot) (igc-stop-collecting-stats) Add docstring for variables: (igc--a) (igc--b) (igc--display-mode) (igc-stats-time-format) --- lisp/emacs-lisp/igc.el | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/lisp/emacs-lisp/igc.el b/lisp/emacs-lisp/igc.el index e9d897f9f64..099e916c14c 100644 --- a/lisp/emacs-lisp/igc.el +++ b/lisp/emacs-lisp/igc.el @@ -36,11 +36,15 @@ igc--diff when (and n1 n2 (/= n1 n2)) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--a nil) -(defvar igc--b nil) -(defvar igc--display-mode 'a) +(defvar igc--a nil + "IGC snapshot A. Used for debugging.") +(defvar igc--b nil + "IGC snapshot B. Used for debugging.") +(defvar igc--display-mode 'a + "IGC stats current snapshot, \='a or \='b.") (defun igc-snapshot () + "Take snapshot A or B depending on igc--display-mode." (interactive) (if (eq igc--display-mode 'a) (setq igc--a (igc-info)) @@ -54,16 +58,19 @@ igc--info-to-display (b igc--b))) (defun igc-display-diff () + "Display the difference between IGC snapshots A and B." (interactive) (setq igc--display-mode 'diff) (igc-stats)) (defun igc-display-a () + "Display IGC stats snapshot A. See igc-stats-mode." (interactive) (setq igc--display-mode 'a) (igc-stats)) (defun igc-display-b () + "Display IGC stats snapshot B. See igc-stats-mode." (interactive) (setq igc--display-mode 'b) (igc-stats)) @@ -174,21 +181,26 @@ igc--roots-diff unless (= n1 n2) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--roots-a nil) -(defvar igc--roots-b nil) +(defvar igc--roots-a nil + "IGC roots snapshot A. Used for debugging statistics.") +(defvar igc--roots-b nil + "IGC roots snapshot B. Used for debugging statistics.") (defvar igc--roots-display-mode 'a) (defun igc-roots-display-diff () +"Display the difference between IGC roots snapshots A and B." (interactive) (setq igc--roots-display-mode 'diff) (igc-roots-stats)) (defun igc-roots-display-a () + "Display IGC roots for snapshot A." (interactive) (setq igc--roots-display-mode 'a) (igc-roots-stats)) (defun igc-roots-display-b () + "Display IGC roots for snapshot B." (interactive) (setq igc--roots-display-mode 'b) (igc-roots-stats)) @@ -209,6 +221,7 @@ igc--roots-info (cl-loop for i being the hash-values of h collect i))) (defun igc--roots-snapshot () + "Display roots snapshots a or b." (interactive) (if (eq igc--roots-display-mode 'a) (setq igc--roots-a (igc--roots-info)) @@ -282,6 +295,7 @@ igc--sqlite ;;;###autoload (defun igc-stop-collecting-stats () + "Stop collecting IGC stats." (interactive) (when igc--collect-timer (cancel-timer igc--collect-timer) @@ -290,7 +304,8 @@ igc-stop-collecting-stats (sqlite-close igc--sqlite) (setq igc--sqlite nil)))) -(defvar igc-stats-time-format "%T.%3N") +(defvar igc-stats-time-format "%T.%3N" + "Time format when exporting IGC stats, e.g. to csv or sqlite.") (defun igc--collect-stats-csv () (let ((buffer (get-file-buffer igc--collect-file))) -- 2.47.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Wed Apr 09 07:49:14 2025 Received: (at 77142) by debbugs.gnu.org; 9 Apr 2025 11:49:14 +0000 Received: from localhost ([127.0.0.1]:38075 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u2Tve-0000eo-GF for submit@debbugs.gnu.org; Wed, 09 Apr 2025 07:49:14 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47502) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u2Tvb-0000eY-U3 for 77142@debbugs.gnu.org; Wed, 09 Apr 2025 07:49:12 -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 1u2TvS-0003Uu-C8; Wed, 09 Apr 2025 07:49:04 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=6o2T83RrnQ8inXj5HnR1SXnUkoIZXl3XjyMpxslFfAA=; b=Y2hxpyCWMxM1 IRfx/nMp/eag5MMDTo57fDruy+mgVzLfOgguWxW91r16Mfz1lyqdF9qKBvQMdn2CwSxnJXUAFZGXb lZPUXtfZDp974RppF4a0IAkwPGNTn9I/We3qcUsW/JKVhOu79z4TD3Q36GCoq04kE5vzrjFVd4fcA Cwa2SVkgTJYp+UpS2PNx3CSe3QKUPVy3F5F74f9As3KoSDaEYS/GddtO9Zw+mj5kCFBNWcWmyq759 f6kRTz/ixVuVPnQ6zdnJu74lJ34qLjL1nmTXcslp+ngYpxr9ijtQNiqqSxi/RPbtK0xu2VlrTSwS/ ghy0mgyseh3yWFEToJzptw==; Date: Wed, 09 Apr 2025 14:48:31 +0300 Message-Id: <86r021sghc.fsf@gnu.org> From: Eli Zaretskii To: Jeremy Bryant In-Reply-To: <871pu2sdz5.fsf@jeremybryant.net> (message from Jeremy Bryant on Tue, 08 Apr 2025 19:30:22 +0100) Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> <874izluncp.fsf@jeremybryant.net> <871pu2sdz5.fsf@jeremybryant.net> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, pipcet@protonmail.com, eller.helmut@gmail.com, 77142@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: Jeremy Bryant > Cc: 77142@debbugs.gnu.org, pipcet@protonmail.com, > gerd.moellmann@gmail.com, eller.helmut@gmail.com > Date: Tue, 08 Apr 2025 19:30:22 +0100 > > (defun igc-display-b () > + "Display IGC stats snapshot A from igc--roots." ^^^ Copy/pasta. > +(defvar igc-stats-time-format "%T.%3N" > + "Time format when exporting IGC stats, e.g. to csv or sqlite.") I think "Time format for exporting..." is better. Thanks. From debbugs-submit-bounces@debbugs.gnu.org Mon Apr 14 13:47:45 2025 Received: (at 77142) by debbugs.gnu.org; 14 Apr 2025 17:47:45 +0000 Received: from localhost ([127.0.0.1]:48859 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u4NuL-0000fD-2W for submit@debbugs.gnu.org; Mon, 14 Apr 2025 13:47:45 -0400 Received: from out-182.mta0.migadu.com ([2001:41d0:1004:224b::b6]:61577) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u4NuH-0000ev-RC for 77142@debbugs.gnu.org; Mon, 14 Apr 2025 13:47:43 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1744652854; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=vaA1NUEhwTAHtwoMt1PAA52IjXLVB/BK7RV+8yBxWTI=; b=ONMqjbYhb+77ZQgqvEOIdvqH0dgHKi7p7U78YbtBFTpTZKP4Yoj/kmXazvJefILkdOWDfu sKiOkpwzY0HIGVV1s1LUI5N4J5JVAT2yfUPz2ow11tJKpYZNBEAw5tiz5iBUln4i7fJ28c lyHiQsXk7GZYNuD/Slhp2nOVR77GEGVzATX+w8gTOWFTsd8yKSciJhj9we+kH7S8mnhMcW QnZd0IxzAAZqTMdCGrRk9ngfJpLnNoojnUS/GYktCTFUNDq9X/Vmw+Rtq9PAzo0GOGoEVH 4/aoGqASY83TaFmCD6QwxyXUgZ9jM9SGCf2eX8ZaX6n2WWAzqiQtP0mBuaxKyQ== From: Jeremy Bryant To: Eli Zaretskii Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions In-Reply-To: <86r021sghc.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 09 Apr 2025 14:48:31 +0300") References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> <874izluncp.fsf@jeremybryant.net> <871pu2sdz5.fsf@jeremybryant.net> <86r021sghc.fsf@gnu.org> Date: Mon, 14 Apr 2025 18:47:32 +0100 Message-ID: <87r01uprd7.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 77142 Cc: gerd.moellmann@gmail.com, pipcet@protonmail.com, eller.helmut@gmail.com, 77142@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 (-) --=-=-= Content-Type: text/plain Attached revised patch to address below points. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-igc.el-checkdox-fixes-for-interactiv.patch >From a3dd7889a58dcac65a4d6dea9e5a9cdb1e8c9564 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Thu, 20 Mar 2025 22:19:33 +0000 Subject: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions Add docstring for interactive functions: (igc-snapshot) (igc-display-diff) (igc-display-a) (igc-display-b) (igc--roots-a) (igc--roots-b) (igc-roots-display-diff) (igc-roots-display-a) (igc-roots-display-b) (igc--roots-snapshot) (igc-stop-collecting-stats) Add docstring for variables: (igc--a) (igc--b) (igc--display-mode) (igc-stats-time-format) --- lisp/emacs-lisp/igc.el | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/lisp/emacs-lisp/igc.el b/lisp/emacs-lisp/igc.el index e9d897f9f64..5841464bbfc 100644 --- a/lisp/emacs-lisp/igc.el +++ b/lisp/emacs-lisp/igc.el @@ -36,11 +36,15 @@ igc--diff when (and n1 n2 (/= n1 n2)) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--a nil) -(defvar igc--b nil) -(defvar igc--display-mode 'a) +(defvar igc--a nil + "IGC snapshot A. Used for debugging.") +(defvar igc--b nil + "IGC snapshot B. Used for debugging.") +(defvar igc--display-mode 'a + "IGC stats current snapshot, \='a or \='b.") (defun igc-snapshot () + "Take snapshot A or B depending on igc--display-mode." (interactive) (if (eq igc--display-mode 'a) (setq igc--a (igc-info)) @@ -54,16 +58,19 @@ igc--info-to-display (b igc--b))) (defun igc-display-diff () + "Display the difference between IGC snapshots A and B." (interactive) (setq igc--display-mode 'diff) (igc-stats)) (defun igc-display-a () + "Display IGC stats snapshot A. See igc-stats-mode." (interactive) (setq igc--display-mode 'a) (igc-stats)) (defun igc-display-b () + "Display IGC stats snapshot B. See igc-stats-mode." (interactive) (setq igc--display-mode 'b) (igc-stats)) @@ -174,21 +181,26 @@ igc--roots-diff unless (= n1 n2) collect (list t1 (- n1 n2) (and s1 (- s1 s2))))) -(defvar igc--roots-a nil) -(defvar igc--roots-b nil) +(defvar igc--roots-a nil + "IGC roots snapshot A. Used for debugging statistics.") +(defvar igc--roots-b nil + "IGC roots snapshot B. Used for debugging statistics.") (defvar igc--roots-display-mode 'a) (defun igc-roots-display-diff () +"Display the difference between IGC roots snapshots A and B." (interactive) (setq igc--roots-display-mode 'diff) (igc-roots-stats)) (defun igc-roots-display-a () + "Display IGC roots for snapshot A." (interactive) (setq igc--roots-display-mode 'a) (igc-roots-stats)) (defun igc-roots-display-b () + "Display IGC roots for snapshot B." (interactive) (setq igc--roots-display-mode 'b) (igc-roots-stats)) @@ -209,6 +221,7 @@ igc--roots-info (cl-loop for i being the hash-values of h collect i))) (defun igc--roots-snapshot () + "Display roots snapshots a or b." (interactive) (if (eq igc--roots-display-mode 'a) (setq igc--roots-a (igc--roots-info)) @@ -282,6 +295,7 @@ igc--sqlite ;;;###autoload (defun igc-stop-collecting-stats () + "Stop collecting IGC stats." (interactive) (when igc--collect-timer (cancel-timer igc--collect-timer) @@ -290,7 +304,8 @@ igc-stop-collecting-stats (sqlite-close igc--sqlite) (setq igc--sqlite nil)))) -(defvar igc-stats-time-format "%T.%3N") +(defvar igc-stats-time-format "%T.%3N" + "Time format for exporting IGC stats, e.g. to csv or sqlite.") (defun igc--collect-stats-csv () (let ((buffer (get-file-buffer igc--collect-file))) -- 2.47.2 --=-=-= Content-Type: text/plain Eli Zaretskii writes: >> From: Jeremy Bryant >> Cc: 77142@debbugs.gnu.org, pipcet@protonmail.com, >> gerd.moellmann@gmail.com, eller.helmut@gmail.com >> Date: Tue, 08 Apr 2025 19:30:22 +0100 >> >> (defun igc-display-b () >> + "Display IGC stats snapshot A from igc--roots." > ^^^ > Copy/pasta. Indeed, sorry. Trivial mistake corrected. > >> +(defvar igc-stats-time-format "%T.%3N" >> + "Time format when exporting IGC stats, e.g. to csv or sqlite.") > > I think "Time format for exporting..." is better. OK - Style noted. > > Thanks. --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 15 01:52:28 2025 Received: (at 77142-done) by debbugs.gnu.org; 15 Apr 2025 05:52:28 +0000 Received: from localhost ([127.0.0.1]:50161 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u4ZDg-0005CU-Aj for submit@debbugs.gnu.org; Tue, 15 Apr 2025 01:52:28 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52276) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u4ZDd-0005CF-AZ for 77142-done@debbugs.gnu.org; Tue, 15 Apr 2025 01:52:26 -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 1u4ZDX-0007Pt-IL; Tue, 15 Apr 2025 01:52:19 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=BFMzt0xkbxU2/LxTcYs1f04nIcrTQ/3DdaTJ0jYuUPM=; b=dLW9pbavbMO3 JqbtSriGfDYOu6k78aPFAQsvwdK5IA6KSl3Dh2rAH5Wb15wcAiITcplLEJQRU2jFRIaquCA0Tnt+M 5mGuKhjvXOFJ444jInmxs5P17tCZ3Zcw6FkvALL+j85L3G4YI6bePzmjCQHX4q42cFwfDjPYId8iy 0S8ICE4Fk52V9dpyoiwvqibIugaKDH9bWJ3sINcmC1UZtjVX8Y1n4fmaWSfrFQNqFzKsA0IsX7xX2 2Z1voEbytIhuIo0K0U8Flw2b0cwIDlTOG1CK5mw+XPRbJlblu8LXd51/GTUGn4uDMsSOCM+S1jgQt Xm9YtGtsxmCJM++2nwLlkg==; Date: Tue, 15 Apr 2025 08:52:15 +0300 Message-Id: <86friahsz4.fsf@gnu.org> From: Eli Zaretskii To: Jeremy Bryant In-Reply-To: <87r01uprd7.fsf@jeremybryant.net> (message from Jeremy Bryant on Mon, 14 Apr 2025 18:47:32 +0100) Subject: Re: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions References: <87bjtvwd6z.fsf@jeremybryant.net> <86bjttjnsl.fsf@gnu.org> <874izluncp.fsf@jeremybryant.net> <871pu2sdz5.fsf@jeremybryant.net> <86r021sghc.fsf@gnu.org> <87r01uprd7.fsf@jeremybryant.net> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 77142-done Cc: gerd.moellmann@gmail.com, pipcet@protonmail.com, eller.helmut@gmail.com, 77142-done@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: Jeremy Bryant > Cc: 77142@debbugs.gnu.org, pipcet@protonmail.com, > gerd.moellmann@gmail.com, eller.helmut@gmail.com > Date: Mon, 14 Apr 2025 18:47:32 +0100 > > Attached revised patch to address below points. Thanks, installed on the igc branch, and closing the bug. From unknown Fri Aug 15 14:16:38 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Tue, 13 May 2025 11:24:11 +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