From unknown Fri Aug 15 20:05:49 2025 X-Loop: help-debbugs@gnu.org Subject: bug#78253: Elisp manual: D.8 Conventional Headers for Emacs Libraries, re: 'History' Resent-From: Cena Mayo Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 05 May 2025 07:19:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 78253 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 78253@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.174642949624185 (code B ref -1); Mon, 05 May 2025 07:19:02 +0000 Received: (at submit) by debbugs.gnu.org; 5 May 2025 07:18:16 +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 1uBq5g-0006Hy-C0 for submit@debbugs.gnu.org; Mon, 05 May 2025 03:18:16 -0400 Received: from lists.gnu.org ([2001:470:142::17]:33560) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1uBdrV-0007kg-Gn for submit@debbugs.gnu.org; Sun, 04 May 2025 14:14:53 -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 1uBdrP-0002j3-P2 for bug-gnu-emacs@gnu.org; Sun, 04 May 2025 14:14:43 -0400 Received: from mail-pj1-x102c.google.com ([2607:f8b0:4864:20::102c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1uBdrN-0006Zp-SP for bug-gnu-emacs@gnu.org; Sun, 04 May 2025 14:14:43 -0400 Received: by mail-pj1-x102c.google.com with SMTP id 98e67ed59e1d1-30820167b47so3433935a91.0 for ; Sun, 04 May 2025 11:14:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1746382479; x=1746987279; darn=gnu.org; h=to:subject:message-id:date:from:mime-version:from:to:cc:subject :date:message-id:reply-to; bh=ysEO8Ty5WWpTA/kMRQStpRhQTJfPUUmSj9zDIFGJVuE=; b=lIKiel5oQ7G8CzZmE3U2055GYWWbqbfiXCQGW0NLOsszZzYw6vSVMaXp1KzC8le9lU a/w/o2xSAzfUPMq1ftt7w2rJRowsaznSqEgio+St8dib3qO7iVvNmtBma+xKEB3sguce ng5tZN6mZJ3m+sWvhpK8UZdhQU3SDnpkLTLWNoGEjmM6dqMp4kLHQMPUUelS2yS4Le5m 4uu8082zSAiTdgDuExOQxCAkrhvxLiwE9GjUiCsxUK9S/jd8DnX4T5P6ph4lkIWiQdjv hXYaM2fhX2+R/j5pHnO4kH0R+5axSyKRPcuN/q74TnJ24Q9GIBSJrPVRIZNlfUvflvO0 rAxg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1746382479; x=1746987279; h=to:subject:message-id:date:from:mime-version:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=ysEO8Ty5WWpTA/kMRQStpRhQTJfPUUmSj9zDIFGJVuE=; b=wmx9XDssZFWAIKmK3zPDtUu/K1F85nM5ioFj6O2D9n1ShmIoevuSdbaptzma5MM69J PwHjSYojn1po3eLId79DAUdKuFf88tQTPF08Eqf8x38+wiRQLtFOt2rAviVwbcwWNA3b wxr4NffK5boD11EAT+wUNm4akoZWFJPAe19H9hBfnmTsgmwYOcG7R6ll2fJ7PEd5odWo J9oAsk61zwdBjGTG/TROTpBoamnOYa0UqkveyewkKc9dTvliNvI+2fN7yDLp26ao89cB hYG55sTTAWiHeZo6MadDRv93EUMPdg3MPisalGXaHbGdANRhH9LA1ECK59ME/EKENjji TkIw== X-Gm-Message-State: AOJu0YxVTpmymSyNiyrEuyfwvegNrKg9pWJYjCshiTQcWzRcesf3PXJq lbCw1vVDMLHZ85FvojoMadzQSUQ1ADPeSFZgZk+NWDRfxekOc6y9Iu5CtiBNiIcoRjYKiHz2nR8 wDNgvbLjoymRrFH3PH9Ojkr3tBKldbnQwFCE= X-Gm-Gg: ASbGnctX0Q7VZCZPDNPw86DH5Gt8K6IZgxmexW+oaRCd9MDv381hI2wZrhp0haVx0xt R8G1fMspFpy37Nv1/LxPyZ4q6BeQt45VdhpgIuFiaesYfNAtUf/SCTJjyXNQV2XCrOq0CxG3Cn0 nLk9ZaK/9wdcX7ns6RF42klSHc6sZuXKDKiyY= X-Google-Smtp-Source: AGHT+IFhGbLM65vDGNPF7+hLeIdhToQhwhLi5oTyJTubykgW1QZKQyPZZ2qJN0A3i7wfsCZRgFZ7BDz3xZXDdj0doE0= X-Received: by 2002:a17:90b:4c51:b0:2ff:5267:e7da with SMTP id 98e67ed59e1d1-30a4e1c94c3mr14286389a91.3.1746382479337; Sun, 04 May 2025 11:14:39 -0700 (PDT) MIME-Version: 1.0 From: Cena Mayo Date: Sun, 4 May 2025 13:14:28 -0500 X-Gm-Features: ATxdqUHpWwKX8tWnpX-e6WisYd42AoOVCO41ex0fNIPHqyShGa0sRUncEHl9CBw Message-ID: Content-Type: multipart/alternative; boundary="00000000000052eed70634535b4b" Received-SPF: pass client-ip=2607:f8b0:4864:20::102c; envelope-from=cenazoic@gmail.com; helo=mail-pj1-x102c.google.com X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, HTML_OBFUSCATE_05_10=0.26, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 1.0 (+) X-Mailman-Approved-At: Mon, 05 May 2025 03:18:14 -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: -0.0 (/) --00000000000052eed70634535b4b Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hi, On https://www.gnu.org/software/emacs/manual/html_node/elisp/Library-Headers.h= tml, the following statement appears: > =E2=80=98;;; Change Log:=E2=80=99 This begins an optional log of changes to the file over time. Don=E2=80=99t= put too much information in this section=E2=80=94it is better to keep the detailed = logs in a version control system (as Emacs does) or in a separate ChangeLog file. = =E2=80=98 History=E2=80=99 is an alternative to =E2=80=98Change Log=E2=80=99. However, 'History' is first mentioned in the line above this one (";;; Commentary:") so suggest it should be defined there, if not on a separate line. 2) > " Here is a table of the conventional possibilities for header-name:" It's not clearly stated (but perhaps implied) that the header-names displayed on this page are (currently) the only ones you should use/can be read by builtin Emacs functions. Can you make up or define your own? Best, C. Mayo --00000000000052eed70634535b4b Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

=C2=A0> " Here is a table of the conventional possibilities for header-name:"
=
It's not clearly stated (but perhaps implied) that the h= eader-names displayed on this page are (currently) the only ones you should= use/can be read by builtin Emacs functions.=C2=A0 Can you make up or defin= e your own?

Best,
C. Mayo
--00000000000052eed70634535b4b-- From unknown Fri Aug 15 20:05:49 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: Cena Mayo Subject: bug#78253: closed (Re: bug#78253: Elisp manual: D.8 Conventional Headers for Emacs Libraries, re: 'History') Message-ID: References: <86tt5zgtgu.fsf@gnu.org> X-Gnu-PR-Message: they-closed 78253 X-Gnu-PR-Package: emacs Reply-To: 78253@debbugs.gnu.org Date: Mon, 05 May 2025 11:59:01 +0000 Content-Type: multipart/mixed; boundary="----------=_1746446341-28635-1" This is a multi-part message in MIME format... ------------=_1746446341-28635-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #78253: Elisp manual: D.8 Conventional Headers for Emacs Libraries, re: 'Hi= story' 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 78253@debbugs.gnu.org. --=20 78253: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D78253 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1746446341-28635-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 78253-done) by debbugs.gnu.org; 5 May 2025 11:58:20 +0000 Received: from localhost ([127.0.0.1]:39349 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1uBuSh-0007QY-Om for submit@debbugs.gnu.org; Mon, 05 May 2025 07:58:20 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:37636) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1uBuSe-0007QB-Us for 78253-done@debbugs.gnu.org; Mon, 05 May 2025 07:58:18 -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 1uBuSZ-0004mu-Hm; Mon, 05 May 2025 07:58:11 -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=7apJtVtf2JojkKBipU0q4hSrWQnT9WKBg7xXUYMr9/E=; b=a7PucNsuqsc8iNvV1vOz Ar331ld/U0wBxruk5U677xZB1cEeHWfB3ueg1cUVFhW5e1TYoCBhKv53hhVtVwXXdyrtVP1+RbjFN aJQYCVN9AX1FCVA+H+BVdj3FEkBrZVZwAMfpxkJi7p4XuDBGljAh6d8pd/SMi4IJMbOw/s7J1NHC8 k7aRHkDmeEVaf4Ia67TcV+PEm0iyT1WUlrHhUxt74a2PJ5aznNKjM/h6cBvbt+bs5bnhO6m+DboT1 KJfTGHf+6g1unIYqq97yGjdenFZ05+4K0Jl1K+loHcUf1KlLtSDKdWiD6ifJ0xMAuOaqhaC+zmFEm A1tGHDJ20L//yQ==; Date: Mon, 05 May 2025 14:58:09 +0300 Message-Id: <86tt5zgtgu.fsf@gnu.org> From: Eli Zaretskii To: Cena Mayo In-Reply-To: (message from Cena Mayo on Sun, 4 May 2025 13:14:28 -0500) Subject: Re: bug#78253: Elisp manual: D.8 Conventional Headers for Emacs Libraries, re: 'History' References: MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 78253-done Cc: 78253-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: Cena Mayo > Date: Sun, 4 May 2025 13:14:28 -0500 > > On https://www.gnu.org/software/emacs/manual/html_node/elisp/Library-Headers.html, > > the following statement appears: > > > > ‘;;; Change Log:’ > > This begins an optional log of changes to the file over time. Don’t put too much information in this > section—it is better to keep the detailed logs in a version control system (as Emacs does) or in a > separate ChangeLog file. ‘History’ is an alternative to ‘Change Log’. > > However, 'History' is first mentioned in the line above this one (";;; Commentary:") so suggest it should be > defined there, if not on a separate line. It's just awkward wording. The text wants to say that the Commentary comments and with one of those lines. I've modified the wording to make that more clear. There's nothing wrong in general in saying "these lines, described below, end this section". > 2) > > " Here is a table of the conventional possibilities for header-name:" > > It's not clearly stated (but perhaps implied) that the header-names displayed on this page are (currently) the > only ones you should use/can be read by builtin Emacs functions. Can you make up or define your own? One can add header lines even though the current Emacs tools don't use them. The "conventional" part hints that those are our conventions, so I think the current wording is good enough. Thanks, the changes are now installed on the emacs-30 release branch. ------------=_1746446341-28635-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 5 May 2025 07:18:16 +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 1uBq5g-0006Hy-C0 for submit@debbugs.gnu.org; Mon, 05 May 2025 03:18:16 -0400 Received: from lists.gnu.org ([2001:470:142::17]:33560) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1uBdrV-0007kg-Gn for submit@debbugs.gnu.org; Sun, 04 May 2025 14:14:53 -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 1uBdrP-0002j3-P2 for bug-gnu-emacs@gnu.org; Sun, 04 May 2025 14:14:43 -0400 Received: from mail-pj1-x102c.google.com ([2607:f8b0:4864:20::102c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1uBdrN-0006Zp-SP for bug-gnu-emacs@gnu.org; Sun, 04 May 2025 14:14:43 -0400 Received: by mail-pj1-x102c.google.com with SMTP id 98e67ed59e1d1-30820167b47so3433935a91.0 for ; Sun, 04 May 2025 11:14:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1746382479; x=1746987279; darn=gnu.org; h=to:subject:message-id:date:from:mime-version:from:to:cc:subject :date:message-id:reply-to; bh=ysEO8Ty5WWpTA/kMRQStpRhQTJfPUUmSj9zDIFGJVuE=; b=lIKiel5oQ7G8CzZmE3U2055GYWWbqbfiXCQGW0NLOsszZzYw6vSVMaXp1KzC8le9lU a/w/o2xSAzfUPMq1ftt7w2rJRowsaznSqEgio+St8dib3qO7iVvNmtBma+xKEB3sguce ng5tZN6mZJ3m+sWvhpK8UZdhQU3SDnpkLTLWNoGEjmM6dqMp4kLHQMPUUelS2yS4Le5m 4uu8082zSAiTdgDuExOQxCAkrhvxLiwE9GjUiCsxUK9S/jd8DnX4T5P6ph4lkIWiQdjv hXYaM2fhX2+R/j5pHnO4kH0R+5axSyKRPcuN/q74TnJ24Q9GIBSJrPVRIZNlfUvflvO0 rAxg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1746382479; x=1746987279; h=to:subject:message-id:date:from:mime-version:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=ysEO8Ty5WWpTA/kMRQStpRhQTJfPUUmSj9zDIFGJVuE=; b=wmx9XDssZFWAIKmK3zPDtUu/K1F85nM5ioFj6O2D9n1ShmIoevuSdbaptzma5MM69J PwHjSYojn1po3eLId79DAUdKuFf88tQTPF08Eqf8x38+wiRQLtFOt2rAviVwbcwWNA3b wxr4NffK5boD11EAT+wUNm4akoZWFJPAe19H9hBfnmTsgmwYOcG7R6ll2fJ7PEd5odWo J9oAsk61zwdBjGTG/TROTpBoamnOYa0UqkveyewkKc9dTvliNvI+2fN7yDLp26ao89cB hYG55sTTAWiHeZo6MadDRv93EUMPdg3MPisalGXaHbGdANRhH9LA1ECK59ME/EKENjji TkIw== X-Gm-Message-State: AOJu0YxVTpmymSyNiyrEuyfwvegNrKg9pWJYjCshiTQcWzRcesf3PXJq lbCw1vVDMLHZ85FvojoMadzQSUQ1ADPeSFZgZk+NWDRfxekOc6y9Iu5CtiBNiIcoRjYKiHz2nR8 wDNgvbLjoymRrFH3PH9Ojkr3tBKldbnQwFCE= X-Gm-Gg: ASbGnctX0Q7VZCZPDNPw86DH5Gt8K6IZgxmexW+oaRCd9MDv381hI2wZrhp0haVx0xt R8G1fMspFpy37Nv1/LxPyZ4q6BeQt45VdhpgIuFiaesYfNAtUf/SCTJjyXNQV2XCrOq0CxG3Cn0 nLk9ZaK/9wdcX7ns6RF42klSHc6sZuXKDKiyY= X-Google-Smtp-Source: AGHT+IFhGbLM65vDGNPF7+hLeIdhToQhwhLi5oTyJTubykgW1QZKQyPZZ2qJN0A3i7wfsCZRgFZ7BDz3xZXDdj0doE0= X-Received: by 2002:a17:90b:4c51:b0:2ff:5267:e7da with SMTP id 98e67ed59e1d1-30a4e1c94c3mr14286389a91.3.1746382479337; Sun, 04 May 2025 11:14:39 -0700 (PDT) MIME-Version: 1.0 From: Cena Mayo Date: Sun, 4 May 2025 13:14:28 -0500 X-Gm-Features: ATxdqUHpWwKX8tWnpX-e6WisYd42AoOVCO41ex0fNIPHqyShGa0sRUncEHl9CBw Message-ID: Subject: Elisp manual: D.8 Conventional Headers for Emacs Libraries, re: 'History' To: bug-gnu-emacs@gnu.org Content-Type: multipart/alternative; boundary="00000000000052eed70634535b4b" Received-SPF: pass client-ip=2607:f8b0:4864:20::102c; envelope-from=cenazoic@gmail.com; helo=mail-pj1-x102c.google.com X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, HTML_OBFUSCATE_05_10=0.26, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: submit X-Mailman-Approved-At: Mon, 05 May 2025 03:18:14 -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: -0.0 (/) --00000000000052eed70634535b4b Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hi, On https://www.gnu.org/software/emacs/manual/html_node/elisp/Library-Headers.h= tml, the following statement appears: > =E2=80=98;;; Change Log:=E2=80=99 This begins an optional log of changes to the file over time. Don=E2=80=99t= put too much information in this section=E2=80=94it is better to keep the detailed = logs in a version control system (as Emacs does) or in a separate ChangeLog file. = =E2=80=98 History=E2=80=99 is an alternative to =E2=80=98Change Log=E2=80=99. However, 'History' is first mentioned in the line above this one (";;; Commentary:") so suggest it should be defined there, if not on a separate line. 2) > " Here is a table of the conventional possibilities for header-name:" It's not clearly stated (but perhaps implied) that the header-names displayed on this page are (currently) the only ones you should use/can be read by builtin Emacs functions. Can you make up or define your own? Best, C. Mayo --00000000000052eed70634535b4b Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

=C2=A0> " Here is a table of the conventional possibilities for header-name:"
=
It's not clearly stated (but perhaps implied) that the h= eader-names displayed on this page are (currently) the only ones you should= use/can be read by builtin Emacs functions.=C2=A0 Can you make up or defin= e your own?

Best,
C. Mayo
--00000000000052eed70634535b4b-- ------------=_1746446341-28635-1--