From: "Drew Adams" <drew.adams@oracle.com>
To: 7783@debbugs.gnu.org
Subject: bug#7783: 24.0.50; (elisp) autoloading nodes, autoload cookie for define-globalized-minor-mode,...
Date: Tue, 4 Jan 2011 13:34:08 -0800 [thread overview]
Message-ID: <E37F27C7A45F4B3CBC502F1F34FB206D@us.oracle.com> (raw)
emacs -Q
C-h i, choose Elisp
Search for autoload. The first occurrence is `Autoload Type', in
subsection `Programming Types'.
The second occurrence is `Autoloading', in subsection `Kinds of Forms'.
It is supposed to be a node on "Functions set up to load files
containing their real definitions" ("their" is not super clear).
So the main menu entry for `Autoloading' is that node.
Continuing to search in the top-level menu we come to `Autoload' in
subsection `Loading'.
So we see that there are at least 3 nodes with very similar node names:
`Autoload Type', `Autoloading', and `Autoload'. The first part of this
bug is that the names should be more specific, referring to the topics
of their relative subsections or some other specificity.
Next, follow the menu link to node `Autoloading'. It is not, as the
main menu said, a node that describes or explains "Functions set up to
load files containing their real definitions". It is a node that is
nearly vacuous of content. It simply gives some general blah-blah about
autoloading and then sends you off to node `Autoload'. So the second
part of this bug is to clean this up - either get rid of this node or
DTRT wrt its purported topic (and rename it, since the name is too
general for the topic).
Following that link we finally get to node `Autoload', which is where
autoloading is explained. There should be a top-level, main menu entry
to this node, and not just a link buried in some subsection (let along 3
links in 3 subsections).
Finally, in node `Autoload' we say that these constructs are handled by
cookies:
"Function-defining forms" include `define-skeleton',
`define-derived-mode', `define-generic-mode' and `define-minor-mode' as
well as `defun' and `defmacro'.
What about `define-globalized-minor-mode'? If that is not handled
similarly, then that is a code bug - it should be. If it is handled
similarly by a cookie then it should be included in the doc list. Users
should not need to consult the source code to try to determine what
an autoload cookie before `define-globalized-minor-mode' will do.
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
of 2011-01-03 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4) --no-opt --cflags
-Ic:/imagesupport/include'
Important settings:
value of $LC_ALL: nil
value of $LC_COLLATE: nil
value of $LC_CTYPE: nil
value of $LC_MESSAGES: nil
value of $LC_MONETARY: nil
value of $LC_NUMERIC: nil
value of $LC_TIME: nil
value of $LANG: ENU
value of $XMODIFIERS: nil
locale-coding-system: cp1252
default enable-multibyte-characters: t
Major mode: Info
Minor modes in effect:
tooltip-mode: t
mouse-wheel-mode: t
tool-bar-mode: t
menu-bar-mode: t
file-name-shadow-mode: t
global-font-lock-mode: t
font-lock-mode: t
blink-cursor-mode: t
auto-composition-mode: t
auto-encryption-mode: t
auto-compression-mode: t
line-number-mode: t
transient-mark-mode: t
Recent input:
C-h i <tab> <tab> <tab> <tab> <tab> <return> C-s a
u t o l o a d C-s <return> <return> l <help-echo> <help-echo>
<help-echo> <help-echo> <help-echo> <help-echo> <help-echo>
<help-echo> <help-echo> <help-echo> <help-echo> <help-echo>
<menu-bar> <help-menu> <send-emacs-bug-report>
Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Composing main Info directory...done
Mark saved where search started
Load-path shadows:
c:/Emacs-24-2011-01-03/lisp/emacs-lisp/sregex hides
c:/Emacs-24-2011-01-03/lisp/obsolete/sregex
c:/Emacs-24-2011-01-03/lisp/pgg hides c:/Emacs-24-2011-01-03/lisp/obsolete/pgg
c:/Emacs-24-2011-01-03/lisp/pgg-pgp5 hides
c:/Emacs-24-2011-01-03/lisp/obsolete/pgg-pgp5
c:/Emacs-24-2011-01-03/lisp/pgg-pgp hides
c:/Emacs-24-2011-01-03/lisp/obsolete/pgg-pgp
c:/Emacs-24-2011-01-03/lisp/pgg-parse hides
c:/Emacs-24-2011-01-03/lisp/obsolete/pgg-parse
c:/Emacs-24-2011-01-03/lisp/pgg-gpg hides
c:/Emacs-24-2011-01-03/lisp/obsolete/pgg-gpg
c:/Emacs-24-2011-01-03/lisp/pgg-def hides
c:/Emacs-24-2011-01-03/lisp/obsolete/pgg-def
Features:
(shadow sort gnus-util mail-extr message rfc822 mml mml-sec mm-decode
mm-bodies mm-encode mail-parse rfc2231 rfc2047 rfc2045 ietf-drums
mm-util mail-prsvr mailabbrev mail-utils gmm-utils mailheader emacsbug
multi-isearch info easymenu dired regexp-opt tooltip ediff-hook vc-hooks
lisp-float-type mwheel dos-w32 disp-table ls-lisp w32-win w32-vars
tool-bar dnd fontset image fringe lisp-mode register page menu-bar
rfn-eshadow timer select scroll-bar mouse jit-lock font-lock syntax
facemenu font-core frame cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese hebrew greek romanian slovak
czech european ethiopic indian cyrillic chinese case-table epa-hook
jka-cmpr-hook help simple abbrev button minibuffer faces cus-face files
text-properties overlay md5 base64 format env code-pages mule custom
widget hashtable-print-readable backquote make-network-process multi-tty
emacs)
next reply other threads:[~2011-01-04 21:34 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-01-04 21:34 Drew Adams [this message]
2011-01-04 23:03 ` bug#7783: 24.0.50; (elisp) autoloading nodes, autoload cookie fordefine-globalized-minor-mode, Drew Adams
2011-01-05 16:52 ` Eli Zaretskii
2011-01-05 18:31 ` Drew Adams
2011-01-05 16:49 ` bug#7783: 24.0.50; (elisp) autoloading nodes, autoload cookie for define-globalized-minor-mode, Eli Zaretskii
2011-01-05 18:31 ` Drew Adams
2012-03-10 4:02 ` Chong Yidong
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=E37F27C7A45F4B3CBC502F1F34FB206D@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=7783@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).