GNU bug report logs - #60762
28.2; info--manual-names ignores Info-additional-directory-list

Previous Next

Package: emacs;

Reported by: Sean Devlin <spd <at> toadstyle.org>

Date: Thu, 12 Jan 2023 23:46:01 UTC

Severity: normal

Found in version 28.2

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 60762 in the body.
You can then email your comments to 60762 AT debbugs.gnu.org in the normal way.

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#60762; Package emacs. (Thu, 12 Jan 2023 23:46:01 GMT) Full text and rfc822 format available.

Acknowledgement sent to Sean Devlin <spd <at> toadstyle.org>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Thu, 12 Jan 2023 23:46:01 GMT) Full text and rfc822 format available.

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

From: Sean Devlin <spd <at> toadstyle.org>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.2; info--manual-names ignores Info-additional-directory-list
Date: Thu, 12 Jan 2023 18:44:50 -0500
Hi folks,

Info.el gives the following advice for customizing the Info manual
search path:

"Normally, you should either set INFOPATH or customize
`Info-additional-directory-list' ..."

The variable Info-additional-directory-list is intended as the main
Lisp-level customization point for users. Its documentation states:

"These directories are searched after those in `Info-directory-list'."

Unfortunately, it is not used consistently across info.el.

In particular, the info--manual-names routine does not respect the
Info-additional-directory-list variable. While this function is internal
to the package, it is used to generate candidates for completing read in
some commands.

Here is a recipe to demonstrate the problem:

1. mkdir -p /tmp/emacs
2. touch /tmp/emacs/example.info
3. emacs -Q
4. M-: (setq Info-additional-directory-list '("/tmp/emacs/")) RET
5. C-h R exam TAB

Observe that there are no completion candidates.

6. C-g
7. M-: (add-to-list 'Info-directory-list "/tmp/emacs/" 'append) RET
8. C-h R exam TAB

Observe that there are completion candidates for the example info file as
expected.

There may be other instances where Info-additional-directory-list is
ignored. For example, I see that the Info-read-node-name-1 function
references Info-directory-list but not Info-additional-directory-list.

Thanks!

In GNU Emacs 28.2
System Description:  macOS 13

Configured using:
'configure --with-ns '--enable-locallisppath=/Library/Application
Support/Emacs/${version}/site-lisp:/Library/Application
Support/Emacs/site-lisp' --with-modules'

Configured features:
ACL GMP GNUTLS JSON LIBXML2 MODULES NOTIFY KQUEUE NS PDUMPER THREADS
TOOLKIT_SCROLL_BARS ZLIB

Important settings:
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  show-paren-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  indent-tabs-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message rmc puny dired dired-loaddefs
rfc822 mml mml-sec epa derived epg rfc6068 epg-config gnus-util rmail
rmail-loaddefs auth-source cl-seq eieio eieio-core cl-macs
eieio-loaddefs password-cache json map text-property-search time-date
subr-x seq byte-opt gv bytecomp byte-compile cconv mm-decode mm-bodies
mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader cl-loaddefs
cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils
info iso-transl tooltip eldoc paren electric uniquify ediff-hook
vc-hooks lisp-float-type elisp-mode mwheel term/ns-win ns-win
ucs-normalize mule-util term/common-win tool-bar dnd fontset image
regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode
prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu
timer select scroll-bar mouse jit-lock font-lock syntax font-core
term/tty-colors frame minibuffer cl-generic cham georgian utf-8-lang
misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms
cp51932 hebrew greek romanian slovak czech european ethiopic indian
cyrillic chinese composite emoji-zwj charscript charprop case-table
epa-hook jka-cmpr-hook help simple abbrev obarray cl-preloaded nadvice
button loaddefs faces cus-face macroexp files window text-properties
overlay sha1 md5 base64 format env code-pages mule custom widget
hashtable-print-readable backquote threads kqueue cocoa ns multi-tty
make-network-process emacs)

Memory information:
((conses 16 53964 7691)
(symbols 48 6840 1)
(strings 32 19755 1604)
(string-bytes 1 669941)
(vectors 16 14412)
(vector-slots 8 199666 13467)
(floats 8 24 38)
(intervals 56 212 4)
(buffers 992 11))




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#60762; Package emacs. (Fri, 13 Jan 2023 08:16:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sean Devlin <spd <at> toadstyle.org>
Cc: 60762 <at> debbugs.gnu.org
Subject: Re: bug#60762: 28.2;
 info--manual-names ignores Info-additional-directory-list
Date: Fri, 13 Jan 2023 10:15:01 +0200
> From: Sean Devlin <spd <at> toadstyle.org>
> Date: Thu, 12 Jan 2023 18:44:50 -0500
> 
> Info.el gives the following advice for customizing the Info manual
> search path:
> 
> "Normally, you should either set INFOPATH or customize
> `Info-additional-directory-list' ..."

This text was removed, and will not appear in Emacs 29 and later.

> The variable Info-additional-directory-list is intended as the main
> Lisp-level customization point for users.

That is inaccurate.  The main Lisp-level customization variable for
users is Info-default-directory-list.  So the question I'd like to ask
before discussing the situations you describe is why don't you
customize Info-default-directory-list instead?

Thanks.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#60762; Package emacs. (Fri, 13 Jan 2023 12:06:02 GMT) Full text and rfc822 format available.

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

From: Sean Devlin <spd <at> toadstyle.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 60762 <at> debbugs.gnu.org
Subject: Re: bug#60762: 28.2; info--manual-names ignores
 Info-additional-directory-list
Date: Fri, 13 Jan 2023 07:04:53 -0500
> On Jan 13, 2023, at 3:15 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> From: Sean Devlin <spd <at> toadstyle.org>
>> Date: Thu, 12 Jan 2023 18:44:50 -0500
>> 
>> Info.el gives the following advice for customizing the Info manual
>> search path:
>> 
>> "Normally, you should either set INFOPATH or customize
>> `Info-additional-directory-list' ..."
> 
> This text was removed, and will not appear in Emacs 29 and later.

Ok.

> 
>> The variable Info-additional-directory-list is intended as the main
>> Lisp-level customization point for users.
> 
> That is inaccurate.  The main Lisp-level customization variable for
> users is Info-default-directory-list.  So the question I'd like to ask
> before discussing the situations you describe is why don't you
> customize Info-default-directory-list instead?

The documentation string for Info-default-directory says:

“Although this is a customizable variable, that is mainly for technical
reasons.  Normally, you should either set INFOPATH or customize
`Info-additional-directory-list', rather than changing this variable.”

To me, this suggests that users should prefer
Info-additional-directory-list. I guess that will change in Emacs 29,
but that is not released yet.

In any case, the documentation string for
Info-additional-directory-list says:

“List of additional directories to search for Info documentation files.
These directories are searched after those in `Info-directory-list’.”

Which is not true in the case I cited.

I am not running Emacs 29 to test, but the documentation for
Info-additional-directory-list and the code for info--manual-names do
not appear to have changed on that branch.

To be clear, I have already worked around this issue in my own
configuration.

Thanks.

> 
> Thanks.





Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#60762; Package emacs. (Fri, 13 Jan 2023 13:20:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sean Devlin <spd <at> toadstyle.org>
Cc: 60762 <at> debbugs.gnu.org
Subject: Re: bug#60762: 28.2; info--manual-names ignores
 Info-additional-directory-list
Date: Fri, 13 Jan 2023 15:18:58 +0200
> From: Sean Devlin <spd <at> toadstyle.org>
> Date: Fri, 13 Jan 2023 07:04:53 -0500
> Cc: 60762 <at> debbugs.gnu.org
> 
> >> The variable Info-additional-directory-list is intended as the main
> >> Lisp-level customization point for users.
> > 
> > That is inaccurate.  The main Lisp-level customization variable for
> > users is Info-default-directory-list.  So the question I'd like to ask
> > before discussing the situations you describe is why don't you
> > customize Info-default-directory-list instead?
> 
> The documentation string for Info-default-directory says:
> 
> “Although this is a customizable variable, that is mainly for technical
> reasons.  Normally, you should either set INFOPATH or customize
> `Info-additional-directory-list', rather than changing this variable.”

This text is no longer in the doc string in Emacs 29.

> To me, this suggests that users should prefer
> Info-additional-directory-list. I guess that will change in Emacs 29,
> but that is not released yet.

Yes, the main customization option is Info-default-directory-list.

> To be clear, I have already worked around this issue in my own
> configuration.

Can you tell whether customizing Info-default-directory-list solves
the problems in your case?  I'd like to know if there's still a
problem we need to consider for Emacs 29.

Thanks.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#60762; Package emacs. (Fri, 13 Jan 2023 17:46:01 GMT) Full text and rfc822 format available.

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

From: Sean Devlin <spd <at> toadstyle.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 60762 <at> debbugs.gnu.org
Subject: Re: bug#60762: 28.2; info--manual-names ignores
 Info-additional-directory-list
Date: Fri, 13 Jan 2023 12:45:20 -0500
> On Jan 13, 2023, at 8:18 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> From: Sean Devlin <spd <at> toadstyle.org>
>> Date: Fri, 13 Jan 2023 07:04:53 -0500
>> Cc: 60762 <at> debbugs.gnu.org
>> 
>>>> The variable Info-additional-directory-list is intended as the main
>>>> Lisp-level customization point for users.
>>> 
>>> That is inaccurate.  The main Lisp-level customization variable for
>>> users is Info-default-directory-list.  So the question I'd like to ask
>>> before discussing the situations you describe is why don't you
>>> customize Info-default-directory-list instead?
>> 
>> The documentation string for Info-default-directory says:
>> 
>> “Although this is a customizable variable, that is mainly for technical
>> reasons.  Normally, you should either set INFOPATH or customize
>> `Info-additional-directory-list', rather than changing this variable.”
> 
> This text is no longer in the doc string in Emacs 29.
> 
>> To me, this suggests that users should prefer
>> Info-additional-directory-list. I guess that will change in Emacs 29,
>> but that is not released yet.
> 
> Yes, the main customization option is Info-default-directory-list.
> 
>> To be clear, I have already worked around this issue in my own
>> configuration.
> 
> Can you tell whether customizing Info-default-directory-list solves
> the problems in your case?  I'd like to know if there's still a
> problem we need to consider for Emacs 29.

In my view, the problem is that the documentation string for
Info-additional-directory-list is not correct. It seems that this
customization option is still supported in the Emacs 29 branch, so I
think it is still a problem regardless of whether this is the
recommended customization option.

That said, I don't think it is an urgent issue.

To answer your question, customizing Info-default-directory-list is
one valid workaround. It does require some care to keep the default
set of directories it generates, but this snippet seems to work:

(custom-set-variables
 '(Info-default-directory-list
   (append Info-default-directory-list
	   '("/path/to/my/info/files/"))))

Thanks.

> 
> Thanks.





Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Fri, 13 Jan 2023 18:26:01 GMT) Full text and rfc822 format available.

Notification sent to Sean Devlin <spd <at> toadstyle.org>:
bug acknowledged by developer. (Fri, 13 Jan 2023 18:26:01 GMT) Full text and rfc822 format available.

Message #22 received at 60762-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sean Devlin <spd <at> toadstyle.org>
Cc: 60762-done <at> debbugs.gnu.org
Subject: Re: bug#60762: 28.2; info--manual-names ignores
 Info-additional-directory-list
Date: Fri, 13 Jan 2023 20:25:27 +0200
> From: Sean Devlin <spd <at> toadstyle.org>
> Date: Fri, 13 Jan 2023 12:45:20 -0500
> Cc: 60762 <at> debbugs.gnu.org
> 
> To answer your question, customizing Info-default-directory-list is
> one valid workaround. It does require some care to keep the default
> set of directories it generates, but this snippet seems to work:
> 
> (custom-set-variables
>  '(Info-default-directory-list
>    (append Info-default-directory-list
> 	   '("/path/to/my/info/files/"))))

Thanks.




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 11 Feb 2023 12:24:09 GMT) Full text and rfc822 format available.

This bug report was last modified 1 year and 46 days ago.

Previous Next


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