GNU bug report logs - #14212
24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings

Previous Next

Package: emacs;

Reported by: "Drew Adams" <drew.adams <at> oracle.com>

Date: Mon, 15 Apr 2013 20:38:02 UTC

Severity: minor

Found in version 24.3.50

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 14212 in the body.
You can then email your comments to 14212 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#14212; Package emacs. (Mon, 15 Apr 2013 20:38:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Drew Adams" <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 15 Apr 2013 20:38:02 GMT) Full text and rfc822 format available.

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.3.50;
	Dired-X manual - variables have no `Variable' or `User Option'
	headings
Date: Mon, 15 Apr 2013 13:33:33 -0700
Subject line says it all.  The manual does not respect the style of
other Emacs doc, such as the Elisp manual.
 
In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600)
 of 2013-04-15 on ODIEONE
Bzr revision: 112292
agustin.martin <at> hispalinux.es-20130415100014-3vaie95fyec9wk37
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib'
 





Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#14212; Package emacs. (Thu, 15 Aug 2019 05:22:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 14212 <at> debbugs.gnu.org
Subject: Re: bug#14212: 24.3.50; Dired-X manual - variables have no
 `Variable' or `User Option' headings
Date: Wed, 14 Aug 2019 22:21:39 -0700
"Drew Adams" <drew.adams <at> oracle.com> writes:

> Subject line says it all.  The manual does not respect the style of
> other Emacs doc, such as the Elisp manual.

I'm not quite sure what you mean here.  There's nodes like "Advanced
Cleaning Variables" -- what are you missing?

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




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#14212; Package emacs. (Thu, 15 Aug 2019 13:07:02 GMT) Full text and rfc822 format available.

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 14212 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#14212: 24.3.50;
 Dired-X manual - variables have no `Variable' or `User Option'
 headings
Date: Thu, 15 Aug 2019 09:06:40 -0400
Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> "Drew Adams" <drew.adams <at> oracle.com> writes:
>
>> Subject line says it all.  The manual does not respect the style of
>> other Emacs doc, such as the Elisp manual.
>
> I'm not quite sure what you mean here.  There's nodes like "Advanced
> Cleaning Variables" -- what are you missing?

I think the problem is that doc/misc/dired-x.texi says stuff like

    @table @code

    @vindex dired-omit-mode
    @item dired-omit-mode
    [...]

Where it should say

    @defvar dired-omit-mode
    [...]
    @end defvar




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#14212; Package emacs. (Thu, 15 Aug 2019 13:44:02 GMT) Full text and rfc822 format available.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Noam Postavsky <npostavs <at> gmail.com>, Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 14212 <at> debbugs.gnu.org
Subject: RE: bug#14212: 24.3.50; Dired-X manual - variables have no `Variable'
 or `User Option' headings
Date: Thu, 15 Aug 2019 06:43:26 -0700 (PDT)
> >> Subject line says it all.  The manual does not respect the style of
> >> other Emacs doc, such as the Elisp manual.
> >
> > I'm not quite sure what you mean here.  There's nodes like "Advanced
> > Cleaning Variables" -- what are you missing?
> 
> I think the problem is that doc/misc/dired-x.texi says stuff like
> 
>     @table @code
> 
>     @vindex dired-omit-mode
>     @item dired-omit-mode
>     [...]
> 
> Where it should say
> 
>     @defvar dired-omit-mode
>     [...]
>     @end defvar

I don't speak Texinfo, but yes, probably.

To repeat: "Subject line says it all."  Contrast the
Elisp manual, where variable descriptions are introduced
with `Variable' or `User Option', macros are introduced
with `Macro', and functions are introduced with `Command'
or `Function'.

See (elisp) `A Sample Variable Description'.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#14212; Package emacs. (Thu, 15 Aug 2019 23:49:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 14212 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#14212: 24.3.50; Dired-X manual - variables have no
 `Variable' or `User Option' headings
Date: Thu, 15 Aug 2019 16:48:21 -0700
Noam Postavsky <npostavs <at> gmail.com> writes:

> I think the problem is that doc/misc/dired-x.texi says stuff like
>
>     @table @code
>
>     @vindex dired-omit-mode
>     @item dired-omit-mode
>     [...]
>
> Where it should say
>
>     @defvar dired-omit-mode
>     [...]
>     @end defvar

Ah, I see.  Yes, that seems like something that should be fixed...  and
I'll leave it for somebody else.  :-)

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




Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Fri, 16 Aug 2019 13:48:02 GMT) Full text and rfc822 format available.

Notification sent to "Drew Adams" <drew.adams <at> oracle.com>:
bug acknowledged by developer. (Fri, 16 Aug 2019 13:48:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 14212-done <at> debbugs.gnu.org, npostavs <at> gmail.com
Subject: Re: bug#14212: 24.3.50;
 Dired-X manual - variables have no `Variable' or `User Option'
 headings
Date: Fri, 16 Aug 2019 16:47:03 +0300
> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Date: Thu, 15 Aug 2019 16:48:21 -0700
> Cc: 14212 <at> debbugs.gnu.org
> 
> > I think the problem is that doc/misc/dired-x.texi says stuff like
> >
> >     @table @code
> >
> >     @vindex dired-omit-mode
> >     @item dired-omit-mode
> >     [...]
> >
> > Where it should say
> >
> >     @defvar dired-omit-mode
> >     [...]
> >     @end defvar
> 
> Ah, I see.  Yes, that seems like something that should be fixed...  and
> I'll leave it for somebody else.  :-)

Someone else here.

Fixed.




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

This bug report was last modified 4 years and 196 days ago.

Previous Next


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