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

Previous Next

Package: emacs;

Reported by: Jeremy Bryant <jb <at> jeremybryant.net>

Date: Sun, 9 Mar 2025 22:31:01 UTC

Severity: wishlist

Tags: patch

Fixed in version 30.2

Done: Stefan Kangas <stefankangas <at> gmail.com>

Bug is archived. No further changes may be made.

Full log


Message #19 received at 76901 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Jeremy Bryant <jb <at> jeremybryant.net>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 76901 <at> debbugs.gnu.org
Subject: Re: bug#76901: [PATCH] ; * doc/emacs/trouble.texi (Coding Standards):
 Add manual reference
Date: Tue, 11 Mar 2025 19:32:59 -0400
Jeremy Bryant <jb <at> jeremybryant.net> writes:

> Eli Zaretskii <eliz <at> gnu.org> writes:
>
>>> From: Stefan Kangas <stefankangas <at> gmail.com>
>>>
>>> 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.
>
> Debian GNU/Linux includes it, in the gnu-standards package, which
> includes both GNU standards and information for Maintainers, available
> in Info, HTML, PDF.

[...]

> AFAICT, other Debian derivatives such as Ubuntu have the same package.
> The upstream GNU package is gnustandards
> https://directory.fsf.org/wiki/Gnustandards
>
> Guix also includes gnustandards, which like other Guix packages can be
> installed on top of any other GNU/Linux distribution.

That's encouraging.

>>> 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?
>
> IMHO we should try to have GNU documentation available locally,
> encourage access locally, not just over the web, for the sake of user
> freedom.
> There are also practical considerations, such as users on laptops
> travelling without a network connection.

All valid points, of course.

> From 513fbf407ebea1681637cc38dad1a0cfd91c5552 Mon Sep 17 00:00:00 2001
> From: Jeremy Bryant <jb <at> jeremybryant.net>
> Date: Sun, 9 Mar 2025 22:25:03 +0000
> Subject: [PATCH] ; * doc/emacs/trouble.texi (Coding Standards): Add manual
>  reference
>
> ---
>  doc/emacs/trouble.texi | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi
> index 2211369b121..95860e9f00f 100644
> --- a/doc/emacs/trouble.texi
> +++ b/doc/emacs/trouble.texi
> @@ -1494,9 +1494,10 @@ Coding Standards
>  @subsection Coding Standards
>  @cindex coding standards for Emacs submissions
>
> -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.
> +Contributed code should follow the GNU Coding Standards.  This manual
> +is available on-line at @url{https://www.gnu.org/prep/standards/}.  It
> +may also be available locally in Info on your system, see @pxref{Top,,,
> +standards, GNU Coding Standards}.

LGTM, but let's wait to see what Eli says.

>
>  If it doesn't, we'll need to find someone to fix the code before we
>  can use it.
> --
> 2.47.2




This bug report was last modified 64 days ago.

Previous Next


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