unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: MON KEY <monkey@sandpframing.com>
To: 6496@debbugs.gnu.org
Subject: bug#6496: documentation manual missing "autoload object" in "What Is a Function" node
Date: Tue, 22 Jun 2010 18:53:38 -0400	[thread overview]
Message-ID: <AANLkTimSLQjVdaZ-E6yC4C4XQ4RJ8LF4QGs_buPKU_zE@mail.gmail.com> (raw)

(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\





             reply	other threads:[~2010-06-22 22:53 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-22 22:53 MON KEY [this message]
2011-07-03 12:34 ` bug#6496: documentation manual missing "autoload object" in "What Is a Function" node Lars Magne Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=AANLkTimSLQjVdaZ-E6yC4C4XQ4RJ8LF4QGs_buPKU_zE@mail.gmail.com \
    --to=monkey@sandpframing.com \
    --cc=6496@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).