GNU bug report logs - #76901
[PATCH] ; * doc/emacs/trouble.texi (Coding Standards): Add manual reference

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Severity: wishlist; Reported by: Jeremy Bryant <jb@HIDDEN>; Keywords: patch; dated Sun, 9 Mar 2025 22:31:01 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.
Severity set to 'wishlist' from 'normal' Request was from Stefan Kangas <stefankangas@HIDDEN> to control <at> debbugs.gnu.org. Full text available.

Message received at 76901 <at> debbugs.gnu.org:


Received: (at 76901) by debbugs.gnu.org; 10 Mar 2025 14:56:41 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Mar 10 10:56:41 2025
Received: from localhost ([127.0.0.1]:39192 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1treYb-0002Cu-AX
	for submit <at> debbugs.gnu.org; Mon, 10 Mar 2025 10:56:41 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10]:44534)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <eliz@HIDDEN>) id 1treYY-0002Cb-F6
 for 76901 <at> debbugs.gnu.org; Mon, 10 Mar 2025 10:56:39 -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 <eliz@HIDDEN>)
 id 1treYS-0004Z7-O8; Mon, 10 Mar 2025 10:56:32 -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=2UJFWuz2j4hkXo05dAQFTg65YOK7wwdFC55p9HVjCRk=; b=iCU4ngd95ssv
 VUtMyYx4lMCz364i+qvSrmUQTiSGHWhTXzfWZqyYoqUov01lhAYCZmagoDWahk9PkRCbwydOPdYm+
 VLbGz+DOYUYmBB97vLR2zoU1up2oml+7otAXdPl5PBVOw2kOiSSoZna8tl0qTVSVFo6J+Crl25EIO
 s3wl2r4aW4AS+lDWY17mjKZajE7A3AR8a6Ej6oANptE48Cb17MNeirSKoSLosTQCpgObOM082kS2b
 ZylIxP40gKKpOmvsPSDcGOgaihgKV3hnmJ5IHU+7AAfgwYJHRJqT2aUOaCS5MwS/rH5T7D7+BvFY/
 Dh1G4IeSuLtmTI8qjMihVw==;
Date: Mon, 10 Mar 2025 16:56:30 +0200
Message-Id: <86wmcxdjdt.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
To: Stefan Kangas <stefankangas@HIDDEN>
In-Reply-To: <CADwFkmn5AZ+YBSKW+BLjXctk=s0wFRW5eMZ_xdnMMH6h3qPw7w@HIDDEN>
 (message from Stefan Kangas on Sun, 9 Mar 2025 16:25:37 -0700)
Subject: Re: bug#76901: [PATCH] ; * doc/emacs/trouble.texi (Coding Standards):
 Add manual reference
References: <87h641zvkw.fsf@HIDDEN>
 <CADwFkmn5AZ+YBSKW+BLjXctk=s0wFRW5eMZ_xdnMMH6h3qPw7w@HIDDEN>
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: 76901
Cc: jb@HIDDEN, 76901 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

> From: Stefan Kangas <stefankangas@HIDDEN>
> Date: Sun, 9 Mar 2025 16:25:37 -0700
> Cc: Eli Zaretskii <eliz@HIDDEN>
> 
> Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of
> text editors" <bug-gnu-emacs@HIDDEN> writes:
> 
> > The Emacs manual suggests that the GNU Coding Standards may be available
> > locally as an Info manual.
> > This patch inserts the explicit manual cross-reference.
> >
> > It may be suitable as a documentation patch for the emacs-30 branch, or
> > otherwise for master.
> >
> > Any comments please let me know.
> 
> I would guess that the reason why there is no reference is that most
> GNU/Linux distributions do not distribute this Info manual, or at least
> they don'tt by default or with commonly installed packages.
> 
> It's also never available as a printed manual, AFAIK.
> 
> I have no opinion on adding such a reference now.  Eli, WDYT?

We have there a reference to the manual in HTML, isn't that enough?
In any case, having a URL and then a cross-reference to the Info
manuals in the next sentence sounds strange to me.  At the very least,
we should have there text saying that the manual can be either read
on-line in HTML format (with the URL), or locally in Info (with a Info
reference), to explain why we have both.




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#76901; Package emacs. Full text available.

Message received at 76901 <at> debbugs.gnu.org:


Received: (at 76901) by debbugs.gnu.org; 9 Mar 2025 23:25:49 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sun Mar 09 19:25:49 2025
Received: from localhost ([127.0.0.1]:34962 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1trQ1k-0006zM-Ux
	for submit <at> debbugs.gnu.org; Sun, 09 Mar 2025 19:25:49 -0400
Received: from mail-ed1-x533.google.com ([2a00:1450:4864:20::533]:44043)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>)
 id 1trQ1h-0006z4-OW
 for 76901 <at> debbugs.gnu.org; Sun, 09 Mar 2025 19:25:46 -0400
Received: by mail-ed1-x533.google.com with SMTP id
 4fb4d7f45d1cf-5e6ff035e9aso490587a12.0
 for <76901 <at> debbugs.gnu.org>; Sun, 09 Mar 2025 16:25:45 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1741562738; x=1742167538; darn=debbugs.gnu.org;
 h=cc:to:subject:message-id:date:mime-version:references:in-reply-to
 :from:from:to:cc:subject:date:message-id:reply-to;
 bh=3g9v8PZgemijjWZMYw2b27BTyva9xn5YxaYwEWWdw4w=;
 b=g1qKJR3/9PJy9Mgsa2MtDu0BBhKL8ZuQg29kayGCtjdJU1ihogNWldfXYVVMr5gID9
 DntLdmcViIwU5/bfkgfCauEeEuFFg3TGlF+VLWxCHol4FFOUpkAwiD729flq0LK3yxHM
 8+MNVAz10bfsKj5Us7ctW2jiEUtrlvkpmjjMLMdvuYwL0rJ/lBAtcfc6S+6OFXvmel61
 didyXY3qCvdSNs8UQdNpiF4IcMufirz7Ky5v056RxAMtPKR89PC0v+fql9kpoFlvK+k+
 UzmaXsHiHOobo+XWZ8n7RbZCEm6pE63m1mKDtm4vaXn8+3Uo/UpJ7FCY7gp/ofnRfaMt
 EHug==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1741562738; x=1742167538;
 h=cc: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=3g9v8PZgemijjWZMYw2b27BTyva9xn5YxaYwEWWdw4w=;
 b=OrAK1I/zNFvXt1WP/hTqrelcSYm5daPApIhF/pCiC2FhH15QXjlnzxXxz7gTOb5rAA
 vXaG7n3w2fn9mnbil6rrG2/mmaDYZSkLPwV3V6FcrZfG0NowYRHyzUoWm/BHlExPg9Nf
 hPOCLgZCT6e4yChEg6xEujBzRgs+H3zN8gvS6wjxImAFexuGnI5xhATb4lzxRqFZrEkC
 Tl7QQDXPaJ4HTYcvUdgGzgGa1sbln46SDwJ0wHTaOWLVM4RBhiahIDjjIjtP3emYZwIg
 o2XH97Kp9v5hvWwIhu8LbFD+ejfnwjmQU2tJkHZeG3DFY6nk1bRuxuxMiZZtsjyS8eoU
 GaaA==
X-Forwarded-Encrypted: i=1;
 AJvYcCWob2iJRYJ34jt61tDcOA20hqazVTV/SsXVcwSgzwr8kaI3bcuStaWb32GuaQB5vB7dBQeoCg==@debbugs.gnu.org
X-Gm-Message-State: AOJu0Yx4P0pENWH9gYw1gJyUFkU+T7BBRCoBnda+HyqMfe6Iov+Z2UHC
 OIkzDhIBhCtHONph5Fm9xx7GFfB1cPH7V5BBq2ImPgJ+NmCaguoyKTnhzkTTQWkf/XCgZ1LJw1S
 MSkBBZrvAKcmkW5ISW1ezC5vWa0k=
X-Gm-Gg: ASbGnct/j1C/QbnHQl5JAdeqwSUImj8+4z3B48Wucf3Kq/H8dUzC5UyCsEaRLUbnRAv
 skrt4C3r835stOS0L91BlH1AXwvd29benb958ST6oHd/bViRUC7zEYssxsABfsizA1L0QW5zs8t
 TbbrB5dnPGcuzi6/jJSlU79FyvJVU=
X-Google-Smtp-Source: AGHT+IHgdhHD9EH6UaRI8813288yfz1CsgUvGaiWn8oGDYv+6QqbrlDZyWM3HqciGKmz5nCZeNnZf87/cpQTENBPLpw=
X-Received: by 2002:a05:6402:51c8:b0:5d0:ed71:3ce4 with SMTP id
 4fb4d7f45d1cf-5e5e22a92a6mr13948717a12.6.1741562738060; Sun, 09 Mar 2025
 16:25:38 -0700 (PDT)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Sun, 9 Mar 2025 16:25:37 -0700
From: Stefan Kangas <stefankangas@HIDDEN>
In-Reply-To: <87h641zvkw.fsf@HIDDEN>
References: <87h641zvkw.fsf@HIDDEN>
MIME-Version: 1.0
Date: Sun, 9 Mar 2025 16:25:37 -0700
X-Gm-Features: AQ5f1Jq2fXdSn1MsthK6xfI5C14LS-119MELpcIDY48eIcssfhKt3OckL4tTU9s
Message-ID: <CADwFkmn5AZ+YBSKW+BLjXctk=s0wFRW5eMZ_xdnMMH6h3qPw7w@HIDDEN>
Subject: Re: bug#76901: [PATCH] ; * doc/emacs/trouble.texi (Coding Standards):
 Add manual reference
To: Jeremy Bryant <jb@HIDDEN>, 76901 <at> debbugs.gnu.org
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 76901
Cc: Eli Zaretskii <eliz@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of
text editors" <bug-gnu-emacs@HIDDEN> writes:

> The Emacs manual suggests that the GNU Coding Standards may be available
> locally as an Info manual.
> This patch inserts the explicit manual cross-reference.
>
> It may be suitable as a documentation patch for the emacs-30 branch, or
> otherwise for master.
>
> Any comments please let me know.

I would guess that the reason why there is no reference is that most
GNU/Linux distributions do not distribute this Info manual, or at least
they don'tt by default or with commonly installed packages.

It's also never available as a printed manual, AFAIK.

I have no opinion on adding such a reference now.  Eli, WDYT?




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#76901; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 9 Mar 2025 22:30:17 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sun Mar 09 18:30:17 2025
Received: from localhost ([127.0.0.1]:34871 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1trPA1-0004Um-AG
	for submit <at> debbugs.gnu.org; Sun, 09 Mar 2025 18:30:17 -0400
Received: from lists.gnu.org ([2001:470:142::17]:58296)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <jb@HIDDEN>)
 id 1trP9z-0004Rx-22
 for submit <at> debbugs.gnu.org; Sun, 09 Mar 2025 18:30:15 -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 <jb@HIDDEN>)
 id 1trP9p-0005vp-EZ
 for bug-gnu-emacs@HIDDEN; Sun, 09 Mar 2025 18:30:07 -0400
Received: from out-177.mta0.migadu.com ([2001:41d0:1004:224b::b1])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <jb@HIDDEN>)
 id 1trP9n-0006AG-8G
 for bug-gnu-emacs@HIDDEN; Sun, 09 Mar 2025 18:30:05 -0400
X-Report-Abuse: Please report any abuse attempt to abuse@HIDDEN and
 include these headers.
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net;
 s=key1; t=1741559393;
 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=YzeFPSCMUR9SlziPTky1/V/GasTgz2hm+7krSTm5do8=;
 b=fynSxvcERPTMknWH7FMrGJjKN6EMQ8jjKFxdi++otepXuhd0ML5O8upRLzCNYIDUrKFvgP
 flR8ZZD1zE1lW+F2qGRc4QluTkJx09wYHrxWFQqMTomcT+kCCAzY5b+tTPRnZtj1yey8R0
 0mJbpuzz9jdpen0Yj7PAi16+05Jq9JARxPXuGlvw9+qIxuYPd7VdiUFSf8lsC2WVd8ddfL
 FwHapkBT9vrvpcrnANF+FTqdcNbADe4Znr5oLNJksFZHvH+q+nRHO/dbPuUgrNAKg28Xz1
 NHM70Su2NDXKgiitH0ngTqmOvJJ4Ma0J4xej93qI+Xq9Le+FTU4cM8UejN0TGA==
From: Jeremy Bryant <jb@HIDDEN>
To: bug-gnu-emacs@HIDDEN
Subject: [PATCH] ; * doc/emacs/trouble.texi (Coding Standards): Add manual
 reference
Date: Sun, 09 Mar 2025 22:29:51 +0000
Message-ID: <87h641zvkw.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
X-Migadu-Flow: FLOW_OUT
Received-SPF: pass client-ip=2001:41d0:1004:224b::b1;
 envelope-from=jb@HIDDEN; helo=out-177.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,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.9 (/)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.1 (/)

--=-=-=
Content-Type: text/plain

The Emacs manual suggests that the GNU Coding Standards may be available
locally as an Info manual.
This patch inserts the explicit manual cross-reference.

It may be suitable as a documentation patch for the emacs-30 branch, or
otherwise for master.

Any comments please let me know.

--=-=-=
Content-Type: text/x-diff
Content-Disposition: attachment;
 filename=0001-doc-emacs-trouble.texi-Coding-Standards-Add-manual-r.patch

From 39bd138d5d9fa82649300d2eaa0a6ec42cb73626 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@HIDDEN>
Date: Sun, 9 Mar 2025 22:25:03 +0000
Subject: [PATCH] ; * doc/emacs/trouble.texi (Coding Standards): Add manual
 reference

---
 doc/emacs/trouble.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi
index 2211369b121..dade3e58bf3 100644
--- a/doc/emacs/trouble.texi
+++ b/doc/emacs/trouble.texi
@@ -1496,7 +1496,7 @@ Coding Standards
 
 Contributed code should follow the GNU Coding Standards
 @url{https://www.gnu.org/prep/standards/}.  This may also be available
-in info on your system.
+in info on your system.  @pxref{Top,,, standards, GNU Coding Standards}
 
 If it doesn't, we'll need to find someone to fix the code before we
 can use it.
-- 
2.47.2


--=-=-=--




Acknowledgement sent to Jeremy Bryant <jb@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#76901; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Mon, 10 Mar 2025 21:15:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.