summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/autoload.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2011-05-03 11:33:05 -0400
committerChong Yidong <cyd@stupidchicken.com>2011-05-03 11:33:05 -0400
commitb7d22a83c2ad41cd922ff0b6e7e7250fec287315 (patch)
tree9def2805d5f8c81fc1fc454a0b7fcba7f9dde970 /lisp/emacs-lisp/autoload.el
parentcdc4a04778d323bba9dbb90b2cf477e4beec1f58 (diff)
downloademacs-b7d22a83c2ad41cd922ff0b6e7e7250fec287315.tar.gz
* emacs-lisp/autoload.el (generated-autoload-file): Doc fix (Bug#7989).
Diffstat (limited to 'lisp/emacs-lisp/autoload.el')
-rw-r--r--lisp/emacs-lisp/autoload.el16
1 files changed, 12 insertions, 4 deletions
diff --git a/lisp/emacs-lisp/autoload.el b/lisp/emacs-lisp/autoload.el
index 5a5d6b88a2d..dffbf3418ca 100644
--- a/lisp/emacs-lisp/autoload.el
+++ b/lisp/emacs-lisp/autoload.el
@@ -35,10 +35,18 @@
(eval-when-compile (require 'cl))
(defvar generated-autoload-file "loaddefs.el"
- "*File \\[update-file-autoloads] puts autoloads into.
-A `.el' file can set this in its local variables section to make its
-autoloads go somewhere else. The autoload file is assumed to contain a
-trailer starting with a FormFeed character.")
+ "File \\[update-file-autoloads] puts autoloads into.
+A Lisp file can set this in its local variables section to make
+its autoloads go somewhere else.
+
+If this is a relative file name, the directory is determined as
+follows:
+ - If a Lisp file defined `generated-autoload-file' as a
+ file-local variable, use its containing directory.
+ - Otherwise use the \"lisp\" subdirectory of `source-directory'.
+
+The autoload file is assumed to contain a trailer starting with a
+FormFeed character.")
;;;###autoload
(put 'generated-autoload-file 'safe-local-variable 'stringp)