summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNoam Postavsky <npostavs@gmail.com>2019-07-05 22:26:13 -0400
committerNoam Postavsky <npostavs@gmail.com>2019-07-06 14:34:47 -0400
commit1f7b602f843d82d2da46528c6cc2a16c794ca668 (patch)
treeb086a1eef2ac989a4acca5304e0537f67ad10d69
parent99a7a188ec052ffcae06ffe49ffe29ccbc2c50ee (diff)
downloademacs-1f7b602f843d82d2da46528c6cc2a16c794ca668.tar.gz
Add commentary about #$ in autoload files
* lisp/emacs-lisp/autoload.el (autoload-rubric): Add commentary about `#$' trick.
-rw-r--r--lisp/emacs-lisp/autoload.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/autoload.el b/lisp/emacs-lisp/autoload.el
index 21b8caccf4b..dfcf17ce1e8 100644
--- a/lisp/emacs-lisp/autoload.el
+++ b/lisp/emacs-lisp/autoload.el
@@ -370,7 +370,11 @@ FILE's name."
";;\n"
";;; Code:\n\n"
(if lp
- ;; `load-path' should contain only directory names.
+ ;; Use the `#$' to indicate current file, from which
+ ;; we extract the directory name. Note that
+ ;; `package-quickstart-refresh' specifically replaces
+ ;; `#$', so any other tricks (e.g., `load-file-name')
+ ;; will not work for that case.
"(add-to-list 'load-path (directory-file-name
(or (file-name-directory #$) (car load-path))))\n\n")
" \n"
@@ -381,7 +385,7 @@ FILE's name."
(file-name-sans-extension basename))))
";; Local Variables:\n"
";; version-control: never\n"
- ";; no-byte-compile: t\n"
+ ";; no-byte-compile: t\n" ;; #$ is byte-compiled into nil.
";; no-update-autoloads: t\n"
";; coding: utf-8\n"
";; End:\n"