GNU bug report logs - #31536
Misused Texinfo markup in misc.texi and ack.texi(emacs-26).

Previous Next

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

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

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

From: Takesi Ayanokoji <ayanokoji.takesi <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Misused Texinfo markup in misc.texi and ack.texi(emacs-26).
Date: Sun, 20 May 2018 10:45:06 +0900

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

Hi Emacs developers.

In misc.texi (and ack.texi), there are misused Texinfo markups.

>>> start here
ack.texi:1099:William Schelter wrote @file{telnet.el}, support for
@code{telnet}
misc.texi:1513:would from a regular terminal (e.g., using the @code{ssh} or
misc.texi:1514:@code{telnet} or @code{rlogin} commands), from a Term window.
<<<end here

I think these @code{...} markups should marked with @command{...}.

Thanks.

ayatakesi <ayanokoji.takesi <at> gmail.com>

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Takesi Ayanokoji <ayanokoji.takesi <at> gmail.com>
Cc: 31536-done <at> debbugs.gnu.org
Subject: Re: bug#31536: Misused Texinfo markup in misc.texi and
 ack.texi(emacs-26).
Date: Sun, 20 May 2018 10:17:09 +0300

> From: Takesi Ayanokoji <ayanokoji.takesi <at> gmail.com>
> Date: Sun, 20 May 2018 10:45:06 +0900
> 
> In misc.texi (and ack.texi), there are misused Texinfo markups.
> 
> >>> start here
> ack.texi:1099:William Schelter wrote @file{telnet.el}, support for @code{telnet}
> misc.texi:1513:would from a regular terminal (e.g., using the @code{ssh} or
> misc.texi:1514:@code{telnet} or @code{rlogin} commands), from a Term window.
> <<<end here
> 
> I think these @code{...} markups should marked with @command{...}.

The effect of @command is the same as that of @code, see the Texinfo
manual.  We didn't use @command for a long time because we tried to be
compatible to old versions of Texinfo, which didn't support it.  Now
that reason is gone, so I fixed the misc.texi parts.  I left alone the
ack.texi part, since I didn't feel like changing attributions just on
behalf of an unimportant markup issue.

Thanks.

Previous Next

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