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

Previous Next

Full log

View this message in rfc822 format

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

[Message part 1 (text/plain, inline)]

OK - Revised patch attached, reasoning below.

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.


File list of package gnu-standards:

/usr/share/doc-base/gnu-standards.gnu-coding-standards
/usr/share/doc-base/gnu-standards.gnu-maintainers-information
/usr/share/doc/gnu-standards/changelog.Debian.gz
/usr/share/doc/gnu-standards/changelog.gz
/usr/share/doc/gnu-standards/copyright
/usr/share/doc/gnu-standards/maintain.dvi.gz
/usr/share/doc/gnu-standards/maintain.html
/usr/share/doc/gnu-standards/maintain.pdf.gz
/usr/share/doc/gnu-standards/maintain.text.gz
/usr/share/doc/gnu-standards/standards.dvi.gz
/usr/share/doc/gnu-standards/standards.html
/usr/share/doc/gnu-standards/standards.pdf.gz
/usr/share/doc/gnu-standards/standards.text.gz
/usr/share/info/maintain.info.gz
/usr/share/info/standards.info.gz

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.

>> 
>> 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.


> 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.

I accept that, and attach a revised patch with the changes made.  Any
further work please let me know.

[0001-doc-emacs-trouble.texi-Coding-Standards-Add-manual-r.patch (text/x-diff, attachment)]

Previous Next

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