GNU bug report logs - #24845
24.5; out-of-date text in (elisp) `Autoload'?

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 24845 in the body.
You can then email your comments to 24845 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: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.5; out-of-date text in (elisp) `Autoload'?
Date: Tue, 1 Nov 2016 08:09:52 -0700 (PDT)

I see this in that node:

  Other definition types:
     defcustom, defgroup, defclass (*note EIEIO: (eieio)Top.), and
     define-skeleton (see the commentary in skeleton.el).
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

But I do not see anything appropriate in the commentary in
`skeleton.el'.  What is this all about?


In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=3D/c/usr --host=3Di686-pc-mingw32'

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

From: npostavs <at> users.sourceforge.net
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 24845 <at> debbugs.gnu.org
Subject: Re: bug#24845: 24.5; out-of-date text in (elisp) `Autoload'?
Date: Tue, 01 Nov 2016 21:13:48 -0400

Drew Adams <drew.adams <at> oracle.com> writes:

> I see this in that node:
>
>   Other definition types:
>      defcustom, defgroup, defclass (*note EIEIO: (eieio)Top.), and
>      define-skeleton (see the commentary in skeleton.el).
>                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> But I do not see anything appropriate in the commentary in
> `skeleton.el'.  What is this all about?

The reference to skeleton.el's commentary was introduced in bc44be50 "*
loading.texi (Autoload): Explicitly state which forms are processed
specially.", there is no additional commentary in skeleton.el regarding
autoloading in that revision either.  I think it's just intended to be
an explanation of what `define-skeleton' is.

Perhaps a better link would be `(autotype) Skeleton Language', similar
to how defclass has a link to eieio.

diff --git i/doc/lispref/loading.texi w/doc/lispref/loading.texi
index 81a1922..82bdde0 100644
--- i/doc/lispref/loading.texi
+++ w/doc/lispref/loading.texi
@@ -610,8 +610,8 @@ Autoload
 
 @item Other definition types:
 @code{defcustom}, @code{defgroup}, @code{defclass}
-(@pxref{Top,EIEIO,,eieio,EIEIO}), and @code{define-skeleton} (see the
-commentary in @file{skeleton.el}).
+(@pxref{Top,EIEIO,,eieio,EIEIO}), and @code{define-skeleton}
+(@pxref{Skeleton Language,,,autotype,Autotyping}).
 @end table
 
   You can also use a magic comment to execute a form at build time

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: npostavs <at> users.sourceforge.net
Cc: 24845 <at> debbugs.gnu.org, drew.adams <at> oracle.com
Subject: Re: bug#24845: 24.5; out-of-date text in (elisp) `Autoload'?
Date: Wed, 02 Nov 2016 17:51:48 +0200

> From: npostavs <at> users.sourceforge.net
> Date: Tue, 01 Nov 2016 21:13:48 -0400
> Cc: 24845 <at> debbugs.gnu.org
> 
> Drew Adams <drew.adams <at> oracle.com> writes:
> 
> > I see this in that node:
> >
> >   Other definition types:
> >      defcustom, defgroup, defclass (*note EIEIO: (eieio)Top.), and
> >      define-skeleton (see the commentary in skeleton.el).
> >                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > But I do not see anything appropriate in the commentary in
> > `skeleton.el'.  What is this all about?
> 
> The reference to skeleton.el's commentary was introduced in bc44be50 "*
> loading.texi (Autoload): Explicitly state which forms are processed
> specially.", there is no additional commentary in skeleton.el regarding
> autoloading in that revision either.  I think it's just intended to be
> an explanation of what `define-skeleton' is.

Indeed, that's also my impression.

> Perhaps a better link would be `(autotype) Skeleton Language', similar
> to how defclass has a link to eieio.

I think we should link to "Using Skeletons", or maybe even to "Top" in
that manual, since the cross-reference is meant for those readers who
don't know what skeletons are.

Thanks.

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

From: npostavs <at> users.sourceforge.net
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 24845 <at> debbugs.gnu.org, drew.adams <at> oracle.com
Subject: Re: bug#24845: 24.5; out-of-date text in (elisp) `Autoload'?
Date: Sat, 05 Nov 2016 10:13:47 -0400

tags 24845 fixed
close 24845 25.2
quit

Eli Zaretskii <eliz <at> gnu.org> writes:
>
> I think we should link to "Using Skeletons", or maybe even to "Top" in
> that manual, since the cross-reference is meant for those readers who
> don't know what skeletons are.

I chose Top in bb61e505.

Previous Next

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