bug#22866: 24.5; 'C-h S' leads to inaccurate result

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[Shiyao Ma]

[-- Attachment #1: Type: text/plain, Size: 5286 bytes --]

For the function `delete-char'.
'C-h S' takes me to:
(emacs)Top > Killing > Deletion and Killing > Deletion

However, it should go to:
(elisp)Top > Text > Deletion


Regards.







In GNU Emacs 24.5.1 (x86_64-pc-linux-gnu)
 of 2015-10-25 on trouble, modified by Debian
System Description:    Debian GNU/Linux testing (stretch)

Configured using:
 `configure --build x86_64-linux-gnu --prefix=/usr
 --sharedstatedir=/var/lib --libexecdir=/usr/lib
 --localstatedir=/var/lib --infodir=/usr/share/info
 --mandir=/usr/share/man --with-pop=yes
 --enable-locallisppath=/etc/emacs24:/etc/emacs:/usr/local/share/emacs/24.5/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.5/site-lisp:/usr/share/emacs/site-lisp
 --build x86_64-linux-gnu --prefix=/usr --sharedstatedir=/var/lib
 --libexecdir=/usr/lib --localstatedir=/var/lib
 --infodir=/usr/share/info --mandir=/usr/share/man --with-pop=yes
 --enable-locallisppath=/etc/emacs24:/etc/emacs:/usr/local/share/emacs/24.5/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.5/site-lisp:/usr/share/emacs/site-lisp
 --with-x=no --without-gconf --without-gsettings 'CFLAGS=-g -O2
 -fstack-protector-strong -Wformat -Werror=format-security -Wall'
 CPPFLAGS=-D_FORTIFY_SOURCE=2 LDFLAGS=-Wl,-z,relro'

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

Major mode: Lisp Interaction

Minor modes in effect:
  elisp-slime-nav-mode: t
  which-key-mode: t
  helm-push-mark-mode: t
  eldoc-mode: t
  helm-mode: t
  shell-dirtrack-mode: t
  helm-adaptive-mode: t
  helm-autoresize-mode: t
  projectile-global-mode: t
  projectile-mode: t
  evil-leader-mode: t
  evil-mode: t
  global-undo-tree-mode: t
  undo-tree-mode: t
  evil-local-mode: t
  override-global-mode: t
  tooltip-mode: t
  electric-indent-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Recent messages:
Loading 00debian-vars...done
Loading /etc/emacs/site-start.d/50autoconf.el (source)...done
Loading /etc/emacs/site-start.d/50cmake-data.el (source)...done
Loading /etc/emacs/site-start.d/50python-docutils.el (source)...done
Turn on helm-projectile key bindings
Loading /home/introom/.emacs.d/cache/helm-adaptive-history...done
Loading term/xterm...done
6am is refreshing
C-c C-x C-g is undefined

Load-path shadows:
/home/introom/.emacs.d/lisp/bundle/helm-20160226.515/helm-multi-match hides
/home/introom/.emacs.d/lisp/bundle/helm-core-20160225.301/helm-multi-match
/usr/share/emacs/24.5/site-lisp/debian-startup hides
/usr/share/emacs/site-lisp/debian-startup
/usr/share/emacs/site-lisp/rst hides
/usr/share/emacs/24.5/lisp/textmodes/rst

Features:
(shadow sort my-mail mail-extr emacsbug message rfc822 mml mml-sec
mm-decode mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils
mailheader sendmail rfc2047 rfc2045 ietf-drums mail-utils xterm
elisp-slime-nav help-mode etags my-conf my-python python json my-lisp
my-org finder-inf which-key my-editfns my-paste my-tmux my-helm
helm-ring helm-elisp helm-eval edebug eldoc helm-mode my-projectile
helm-projectile helm-files rx image-dired tramp tramp-compat
tramp-loaddefs trampver shell pcomplete format-spec dired-x dired-aux
ffap helm-tags helm-bookmark helm-adaptive helm-info bookmark pp
helm-external helm-net browse-url xml url url-proxy url-privacy
url-expand url-methods url-history url-cookie url-domsuf url-util
url-parse auth-source gnus-util time-date mm-util mail-prsvr
password-cache url-vars mailcap helm-buffers helm-grep helm-regexp
helm-plugin helm-elscreen helm-utils helm-locate helm-help helm-types
helm cl-macs gv helm-source eieio eieio-core helm-multi-match helm-lib
dired projectile grep compile comint regexp-opt ansi-color ibuf-ext
ibuffer dash my-evil evil-leader evil evil-integration undo-tree diff
evil-maps evil-commands evil-jumps evil-command-window evil-types
evil-search evil-ex evil-macros evil-repeat evil-states evil-core
byte-opt advice help-fns evil-common windmove thingatpt rect
evil-digraphs evil-vars ring my-utils my-graphics use-package diminish
bytecomp byte-compile cl-extra cconv bind-key easy-mmode info tool-bar
easymenu package epg-config edmacro kmacro cl-loaddefs cl-lib tooltip
electric uniquify ediff-hook vc-hooks lisp-float-type tabulated-list
newcomment lisp-mode prog-mode register page menu-bar rfn-eshadow timer
select mouse jit-lock font-lock syntax facemenu font-core frame cham
georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao
korean japanese hebrew greek romanian slovak czech european ethiopic
indian cyrillic chinese case-table epa-hook jka-cmpr-hook help simple
abbrev minibuffer nadvice loaddefs button faces cus-face macroexp files
text-properties overlay sha1 md5 base64 format env code-pages mule
custom widget hashtable-print-readable backquote make-network-process
dbusbind gfilenotify multi-tty emacs)

Memory information:
((conses 16 261152 278018)
 (symbols 48 34742 86)
 (miscs 40 33 217)
 (strings 32 64423 168511)
 (string-bytes 1 1823292)
 (vectors 16 28574)
 (vector-slots 8 545442 111244)
 (floats 8 150 478)
 (intervals 56 272 79)
 (buffers 960 12)
 (heap 1024 61906 19303))

[-- Attachment #2: Type: text/html, Size: 5803 bytes --]

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[Drew Adams]

> For the function `delete-char'.  'C-h S' takes me to:
> (emacs)Top > Killing > Deletion and Killing > Deletion 
> However, it should go to: (elisp)Top > Text > Deletion

Why do you think so?  This is a user command, not just an
Elisp function.  An Emacs user looking for information about
it interactively will expect to go to its description in the
Emacs manual.  If we have to choose one or the other, we
should, I think, favor user help, especially for a command.

That said... (1) Maybe we could cross-reference the one from
the other manual?  (2) It might be good if `C-h S' popped
up a buffer of links to references in both manuals.  (3) It
would be good if *Help* output from `C-h f' and `C-h k'
provided links to the manuals (both).

----

FWIW, my library `help-fns+.el' does provide references to
the manuals in the output of help commands such as `C-h f' and
`C-h k'.  But it does not provide such links for `C-h S'.

If you click the link on `manuals' in the `*Help*' output:
"For more information check the manuals." then you get this
Info buffer, where the left column has links to the nodes
listed in the right column:

File: *Indexed*,  Node: Index for `delete-char',  Up: Top

Index Matches

Index entries that match `delete-char':

* Menu:

* delete-char [elisp]:            (elisp)Deletion.
* delete-char [emacs]:            (emacs)Deletion.

http://www.emacswiki.org/emacs/download/help-fns%2b.el

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[Eli Zaretskii]

> Date: Tue, 1 Mar 2016 06:52:53 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> 
> > For the function `delete-char'.  'C-h S' takes me to:
> > (emacs)Top > Killing > Deletion and Killing > Deletion 
> > However, it should go to: (elisp)Top > Text > Deletion
> 
> Why do you think so?  This is a user command, not just an
> Elisp function.  An Emacs user looking for information about
> it interactively will expect to go to its description in the
> Emacs manual.  If we have to choose one or the other, we
> should, I think, favor user help, especially for a command.
> 
> That said... (1) Maybe we could cross-reference the one from
> the other manual?  (2) It might be good if `C-h S' popped
> up a buffer of links to references in both manuals.  (3) It
> would be good if *Help* output from `C-h f' and `C-h k'
> provided links to the manuals (both).

I think the way to solve this is to have a new Help command that would
specifically look up a function name in the ELisp manual.

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[Drew Adams]

> > > For the function `delete-char'.  'C-h S' takes me to:
> > > (emacs)Top > Killing > Deletion and Killing > Deletion
> > > However, it should go to: (elisp)Top > Text > Deletion
> >
> > Why do you think so?  This is a user command, not just an
> > Elisp function.  An Emacs user looking for information about
> > it interactively will expect to go to its description in the
> > Emacs manual.  If we have to choose one or the other, we
> > should, I think, favor user help, especially for a command.
> >
> > That said... (1) Maybe we could cross-reference the one from
> > the other manual?  (2) It might be good if `C-h S' popped
> > up a buffer of links to references in both manuals.  (3) It
> > would be good if *Help* output from `C-h f' and `C-h k'
> > provided links to the manuals (both).
> 
> I think the way to solve this is to have a new Help command that
> would specifically look up a function name in the ELisp manual.

That too would work.

If someone wanted references to both manuals, it would still be
helpful if that new command, as well as `C-h S', interpreted
certain prefix-arg values as requesting that, and showed links
to them (e.g., as I described).

For example:

* A non-negative prefix arg could do as now: query for the mode.
* A non-positive prefix arg could show links to both manuals.

(So a zero arg would do both.)

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[John Wiegley]

>>>>> Eli Zaretskii <eliz@gnu.org> writes:

> I think the way to solve this is to have a new Help command that would
> specifically look up a function name in the ELisp manual.

Just FYI, the info-look module can be configured to also look up things in the
elisp manual. I've been using it to do this for years now, via
`info-lookup-symbol'. And it's already part of Emacs, so we'd just need to
integrate by default.

-- 
John Wiegley                  GPG fingerprint = 4710 CF98 AF9B 327B B80F
http://newartisans.com                          60E1 46C4 BD1A 7AC1 4BA2

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[Shiyao Ma]

[-- Attachment #1: Type: text/plain, Size: 765 bytes --]

On 2 March 2016 at 07:09, John Wiegley <jwiegley@gmail.com> wrote:

>
> Just FYI, the info-look module can be configured to also look up things in
> the
> elisp manual. I've been using it to do this for years now, via
> `info-lookup-symbol'. And it's already part of Emacs, so we'd just need to
> integrate by default.
>
>
>
It does look up symbols under elisp manual from time to time. The problem
here is for functions like `delete-char', both emacs manual and elisp
manual contain it and  info-lookup-symbol  prefers the latter under both
emacs-lisp-mode and lisp-mode.

Possible to tell info-lookup-symbol prefer elisp manual ?


Regards.



-- 

吾輩は猫である。ホームーページはhttps://introo.me <http://introo.me>。

[-- Attachment #2: Type: text/html, Size: 1392 bytes --]

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[John Wiegley]

>>>>> Shiyao Ma <i@introo.me> writes:

> It does look up symbols under elisp manual from time to time. The problem
> here is for functions like `delete-char', both emacs manual and elisp manual
> contain it and info-lookup-symbol prefers the latter under both
> emacs-lisp-mode and lisp-mode.

> Possible to tell info-lookup-symbol prefer elisp manual ?

There is an extension package, Info-lookmore, which will let you browse
multiple manuals for a symbol, if I remember correctly...

-- 
John Wiegley                  GPG fingerprint = 4710 CF98 AF9B 327B B80F
http://newartisans.com                          60E1 46C4 BD1A 7AC1 4BA2

bug#22866: 24.5; 'C-h S' leads to inaccurate result

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@gnu.org> writes:

> I think the way to solve this is to have a new Help command that would
> specifically look up a function name in the ELisp manual.

I've now added this to Emacs 29, bound to `I'.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no