GNU bug report logs - #6496
documentation manual missing "autoload object" in "What Is a Function" node

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 6496 in the body.
You can then email your comments to 6496 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: MON KEY <monkey <at> sandpframing.com>
To: bug-gnu-emacs <at> gnu.org
Subject: documentation manual missing "autoload object" in "What Is a 
	Function" node
Date: Tue, 22 Jun 2010 18:53:38 -0400

(info "(elisp)What Is a Function")

Does not mention "autoload objects" as a "type" of function.

It should do so and make an xref to (info "(elisp)Autoload Type").

Following is an attempt at documenting the object:

,----
|
| "autoload object"
| An "autoload object" stores a function definition in a placeholder
| for the real definition of a symbol-function.  The autoload object
| says that the real definition is found in a file of Lisp code which
| should be loaded when necessary.  An autoload object is stored as a
| list with the first element being the symbol `autoload'.
|
`----

The rationale for including this documentation is that both
`indirect-function' and `symbol-function' will return an autoload list
if the function has yet to be brought into the environment, e.g.:

(when (featurep 'dunnet) (unload-feature 'dunnet))

(symbol-function 'dunnet)
;=> (autoload "dunnet" 940287 t nil)

(require 'dunnet)

(symbol-function 'dunnet)
;=> #[ <BIG-VECTOR-HERE> ... ]

These differences of return value w/re both `indirect-function' and
`symbol-function' may be surprising to some esp. as there isn't an
autoload predicate (that I'm aware of).

--
/s_P\

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: MON KEY <monkey <at> sandpframing.com>
Cc: 6496 <at> debbugs.gnu.org
Subject: Re: documentation manual missing "autoload object" in "What Is a
	Function" node
Date: Sun, 03 Jul 2011 14:34:31 +0200

MON KEY <monkey <at> sandpframing.com> writes:

> Does not mention "autoload objects" as a "type" of function.
>
> It should do so and make an xref to (info "(elisp)Autoload Type").
>
> Following is an attempt at documenting the object:
>
> ,----
> |
> | "autoload object"
> | An "autoload object" stores a function definition in a placeholder
> | for the real definition of a symbol-function.  The autoload object
> | says that the real definition is found in a file of Lisp code which
> | should be loaded when necessary.  An autoload object is stored as a
> | list with the first element being the symbol `autoload'.
> |
> `----

I've installed a similar definition in the Emacs 24 manual.

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

Previous Next

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