bug#8398: 24.0.50; info-mode adding spurious "see" to @ref links

bug#8398: 24.0.50; info-mode adding spurious "see" to @ref links

[Jason Earl]

This bug report will be sent to the Free Software Foundation,
not to your local site managers!
Please write in English if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.

Your report will be posted to the bug-gnu-emacs@gnu.org mailing list
and the gnu.emacs.bug news group, and at http://debbugs.gnu.org.

Please describe exactly what actions triggered the bug
and the precise symptoms of the bug.  If you can, give
a recipe starting from `emacs -Q':

I have a Texinfo file that I am working on that uses constructs like:

For more information on info itself you can read
@iftex
@cite{Info: An Introduction}.
@end iftex
@ifnottex
@ref{Top, , Info, info, Info: An Introduction}.
@end ifnottex

The info file produced, and it looked fine in the info client.

   For more information on info itself you can read *note Info:
(info)Top.

However, in Emacs' info-mode it looks like this:

   For more information on info itself you can read *note Info:
(info)Top.

Essentially it replaced the *note with the word "see" which makes the
sentence read funny.

The same thing can be seen in the Emacs Lisp Intro (which is where I
borrowed the Texinfo bits from.

If Emacs crashed, and you have the Emacs process in the gdb debugger,
please include the output from the following gdb commands:
    `bt full' and `xbacktrace'.
For information about debugging Emacs, please read the file
/usr/local/share/emacs/24.0.50/etc/DEBUG.


In GNU Emacs 24.0.50.1 (i686-pc-linux-gnu, GTK+ Version 2.22.0)
 of 2011-03-28 on c3po
Windowing system distributor `The X.Org Foundation', version 11.0.10900000
Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_US.utf8
  value of $XMODIFIERS: nil
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Major mode: Info

Minor modes in effect:
  tooltip-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
  transient-mark-mode: t

Recent input:
C-h i m p r a <tab> <return> <down> <down> <down> <down> 
<down> <down> <down> <down> <down> <down> <down> <down> 
<down> <down> <down> <down> <down> <down> <down> <down> 
<down> <down> <down> <down> <return> SPC SPC <down> 
<down> <down> <down> <down> <down> <down> <down> <down> 
<down> M-x r e p o <tab> r <tab> <return>

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Composing main Info directory...done
Making completion list...

Load-path shadows:
/usr/local/share/emacs/site-lisp/emms/tq hides /usr/local/share/emacs/24.0.50/lisp/emacs-lisp/tq

Features:
(shadow sort mail-extr message sendmail regexp-opt format-spec rfc822
mml mml-sec mm-decode mm-bodies mm-encode mail-parse rfc2231 rfc2047
rfc2045 ietf-drums mailabbrev mail-utils gmm-utils mailheader emacsbug
url-util url-parse auth-source eieio byte-opt bytecomp byte-compile
assoc gnus-util time-date password-cache url-vars mm-util mail-prsvr
help-mode view info easymenu tooltip ediff-hook vc-hooks lisp-float-type
mwheel x-win x-dnd tool-bar dnd fontset image fringe lisp-mode register
page menu-bar rfn-eshadow timer select scroll-bar 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 loaddefs button
minibuffer faces cus-face files text-properties overlay md5 base64
format env code-pages mule custom widget hashtable-print-readable
backquote make-network-process dbusbind dynamic-setting
system-font-setting font-render-setting move-toolbar gtk x-toolkit x
multi-tty emacs)

bug#8398: 24.0.50; info-mode adding spurious "see" to @ref links

[Glenn Morris]

Jason Earl wrote:

> For more information on info itself you can read
> @iftex
> @cite{Info: An Introduction}.
> @end iftex
> @ifnottex
> @ref{Top, , Info, info, Info: An Introduction}.
> @end ifnottex
>
> The info file produced, and it looked fine in the info client.
>
>    For more information on info itself you can read *note Info:
> (info)Top.
>
> However, in Emacs' info-mode it looks like this:
>
>    For more information on info itself you can read *note Info:
> (info)Top.
>
> Essentially it replaced the *note with the word "see" which makes the
> sentence read funny.

I think you mis-typed your second example...

The behaviour is customizable through Info-hide-note-references.

The elisp intro does not say "you can read", so looks OK IMO:

   This introduction to `Programming in Emacs Lisp' has a companion
document, see The GNU Emacs Lisp Reference Manual.

Personally I think your "you can read @ref" is not really Texinfo style (?),
which is why the result looks a bit odd.

http://www.gnu.org/s/hello/manual/texinfo/ref.html

bug#8398: 24.0.50; info-mode adding spurious "see" to @ref links

[Eli Zaretskii]

> From: Glenn Morris <rgm@gnu.org>
> Date: Thu, 31 Mar 2011 20:25:43 -0400
> Cc: 8398@debbugs.gnu.org
> 
> > However, in Emacs' info-mode it looks like this:
> >
> >    For more information on info itself you can read *note Info:
> > (info)Top.
> >
> > Essentially it replaced the *note with the word "see" which makes the
> > sentence read funny.
> 
> I think you mis-typed your second example...

No, he copy/pasted it from Emacs, and therefore the original text
replaced by Emacs display wizardry reappeared...

> Personally I think your "you can read @ref" is not really Texinfo style (?),
> which is why the result looks a bit odd.

Indeed, that's bad Texinfo and should be fixed.

bug#8398: 24.0.50; info-mode adding spurious "see" to @ref links

[Jason Earl]

On Thu, Mar 31 2011, Glenn Morris wrote:

> Jason Earl wrote:
>
>> For more information on info itself you can read
>> @iftex
>> @cite{Info: An Introduction}.
>> @end iftex
>> @ifnottex
>> @ref{Top, , Info, info, Info: An Introduction}.
>> @end ifnottex
>>
>> The info file produced, and it looked fine in the info client.
>>
>>    For more information on info itself you can read *note Info:
>> (info)Top.
>>
>> However, in Emacs' info-mode it looks like this:
>>
>>    For more information on info itself you can read *note Info:
>> (info)Top.
>>
>> Essentially it replaced the *note with the word "see" which makes the
>> sentence read funny.
>
> I think you mis-typed your second example...
>
> The behaviour is customizable through Info-hide-note-references.
>
> The elisp intro does not say "you can read", so looks OK IMO:
>
>    This introduction to `Programming in Emacs Lisp' has a companion
> document, see The GNU Emacs Lisp Reference Manual.
>
> Personally I think your "you can read @ref" is not really Texinfo style (?),
> which is why the result looks a bit odd.
>
> http://www.gnu.org/s/hello/manual/texinfo/ref.html

I am sorry for the noise.  I borrowed the Texinfo from the /Emacs Lisp
Intro/ (it seemed like a safe bet), and then the output appeared
differently in Emacs and the info file reader, so I thought it might be
a bug.

I am starting to realize that borrowing examples from the /Emacs Lisp
Intro/ is not a good idea.  This is the second time that has bitten me.

I will reword my Texinfo source and call it good.  Thanks for looking
into this, and, once again, sorry for the noise.

Jason Earl

bug#8398: 24.0.50; info-mode adding spurious "see" to @ref links

[Glenn Morris]

No worries.