GNU bug report logs - #69734
BUG: Inconsistent Emacs documentation...

Previous Next

To reply to this bug, email your comments to 69734 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

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

From: Mikael Larsson <mikael.x.larsson <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: BUG: Inconsistent Emacs documentation...
Date: Mon, 11 Mar 2024 14:34:35 +0100

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

 To Whom It May Concern,

I just downloaded the documentation for Emacs 29.2 as a pdf file. Comparing
this to the version online I can see that the content is not the same. At
least one of the versions is faulty or out of date. I'm referring to links
on the following page:
https://www.gnu.org/software/emacs/manual/emacs.html

Looking at "HTML - one page per node" I can see that chapter 15.22 is "Line
Truncation". If I look at the pdf version "Main PDF file", that chapter is
11.22. The pdf document is labeled as consistent with version 29.2 on page
T-3. I assume this is just an issue with generating the pdf version.
Thanks in advance for your help.

Best regards,
Mikael Larsson
Buried in 3 feet of snow in the north of Sweden and struggling with
elisp...🥺

*Q*: How can I get the full output of the macro expansion below? I assume
it's some variable that needs tweaking, but I can't find it in the manual.
Thank you.

(macroexpand-1 '(cl-defstruct queue head tail))
(progn (defvar cl-struct-queue-tags) (cl-defsubst queue-p (cl-x) (declare
(side-effect-free error-free) (pure t)) (and (memq ...
cl-struct-queue-tags) t)) (eval-and-compile (define-symbol-prop 'queue
'cl-deftype-satisfies 'queue-p)) (cl-defsubst queue-head (cl-x) "Access
slot \"head\" of `queue' struct CL-X." (declare (side-effect-free t))
(progn (or ... ...) (aref cl-x 1))) (cl-defsubst queue-tail (cl-x) "Access
slot \"tail\" of `queue' struct CL-X." (declare (side-effect-free t))
(progn (or ... ...) (aref cl-x 2))) (defalias 'copy-queue #'copy-sequence)
(cl-defsubst make-queue (&cl-defs (nil ... ... ...) &key head tail)
"Constructor for objects of type `queue'." (declare (side-effect-free t))
(record 'queue head tail)) :autoload-end (eval-and-compile
(cl-struct-define 'queue nil 'cl-structure-object 'record nil '(... ...
...) 'cl-struct-queue-tags 'queue 't)) 'queue)

[Message part 2 (text/html, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Mikael Larsson <mikael.x.larsson <at> gmail.com>
Cc: 69734 <at> debbugs.gnu.org
Subject: Re: bug#69734: BUG: Inconsistent Emacs documentation...
Date: Mon, 11 Mar 2024 18:43:39 +0200

> From: Mikael Larsson <mikael.x.larsson <at> gmail.com>
> Date: Mon, 11 Mar 2024 14:34:35 +0100
> 
> I just downloaded the documentation for Emacs 29.2 as a pdf file. Comparing this to the version online I can
> see that the content is not the same. At least one of the versions is faulty or out of date. I'm referring to links
> on the following page:
> https://www.gnu.org/software/emacs/manual/emacs.html
> 
> Looking at "HTML - one page per node" I can see that chapter 15.22 is "Line Truncation". If I look at the pdf
> version "Main PDF file", that chapter is 11.22. The pdf document is labeled as consistent with version 29.2 on
> page T-3. I assume this is just an issue with generating the pdf version. 
> Thanks in advance for your help.

This is normal: the printed version of the manual omits some of the
material, to make the printed book smaller and less expensive.  You
are well advised to use an on-line version, either HTML or the Info
version (the latter is part of a standard Emacs installation).

> Q: How can I get the full output of the macro expansion below? I assume it's some variable that needs
> tweaking, but I can't find it in the manual. Thank you.

I think you are looking for the answer in the wrong manual.  You
should look in the ELisp Reference manual, there's a section there
named "Expansion of a Macro Call".

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Mikael Larsson <mikael.x.larsson <at> gmail.com>
Cc: 69734 <at> debbugs.gnu.org
Subject: Re: bug#69734: BUG: Inconsistent Emacs documentation...
Date: Fri, 15 Mar 2024 13:44:04 +0200

severity 69734 wishlist
thanks

Resending Mikael's response, which was sent only to me:

> From: Mikael Larsson <mikael.x.larsson <at> gmail.com>
> Date: Fri, 15 Mar 2024 11:49:26 +0100
> 
> Hi Eli,
> 
> Thank you for your reply!
> A few comments on your answer:
> Please consider making two PDFs available on the download page. The current one that is a copy of the
> printed version and a new one with the full documentation. It's most convenient to have the full documentation
> in PDF, making full search easy.  This will also offload searches on your website as well.
> 
> Kind regards and have a nice weekend,
> Mikael Larsson

Thank you for your comments.  For now, we don't have the resources to
produce two versions if each PDF manual, but maybe one day in the
future.

I've now converted this bug report to a feature request.

Previous Next

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