diff options
| author | Glenn Morris <rgm@gnu.org> | 2017-11-27 14:10:34 -0500 |
|---|---|---|
| committer | Glenn Morris <rgm@gnu.org> | 2017-11-27 14:10:34 -0500 |
| commit | 1c8bd8a119b9c96763d3b6c5447d9e9e26a6f922 (patch) | |
| tree | 758086fd56a567591a39fa35342385ce013d0ff9 /lisp/emacs-lisp/bytecomp.el | |
| parent | 37f3a6b216f385b1aef5310bff0ea5abb24f7637 (diff) | |
| download | emacs-1c8bd8a119b9c96763d3b6c5447d9e9e26a6f922.tar.gz emacs-1c8bd8a119b9c96763d3b6c5447d9e9e26a6f922.tar.bz2 emacs-1c8bd8a119b9c96763d3b6c5447d9e9e26a6f922.zip | |
A few small doc fixes for bytecomp.el
* lisp/emacs-lisp/bytecomp.el (emacs-lisp-file-regexp)
(byte-compile-dest-file-function, byte-compile-dest-file): Doc fixes.
Diffstat (limited to 'lisp/emacs-lisp/bytecomp.el')
| -rw-r--r-- | lisp/emacs-lisp/bytecomp.el | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el index 590db570c56..7b17d9f2900 100644 --- a/lisp/emacs-lisp/bytecomp.el +++ b/lisp/emacs-lisp/bytecomp.el @@ -144,14 +144,20 @@ (defcustom emacs-lisp-file-regexp "\\.el\\'" "Regexp which matches Emacs Lisp source files. -If you change this, you might want to set `byte-compile-dest-file-function'." +If you change this, you might want to set `byte-compile-dest-file-function'. +\(Note that the assumption of a \".elc\" suffix for compiled files +is hard-coded in various places in Emacs.)" + ;; Eg is_elc in Fload. :group 'bytecomp :type 'regexp) (defcustom byte-compile-dest-file-function nil "Function for the function `byte-compile-dest-file' to call. It should take one argument, the name of an Emacs Lisp source -file name, and return the name of the compiled file." +file name, and return the name of the compiled file. +\(Note that the assumption that the source and compiled files +are found in the same directory is hard-coded in various places in Emacs.)" + ;; Eg load-prefer-newer, documentation lookup IIRC. :group 'bytecomp :type '(choice (const nil) function) :version "23.2") @@ -170,8 +176,9 @@ file name, and return the name of the compiled file." "Convert an Emacs Lisp source file name to a compiled file name. If `byte-compile-dest-file-function' is non-nil, uses that function to do the work. Otherwise, if FILENAME matches -`emacs-lisp-file-regexp' (by default, files with the extension `.el'), -adds `c' to it; otherwise adds `.elc'." +`emacs-lisp-file-regexp' (by default, files with the extension \".el\"), +replaces the matching part (and anything after it) with \"\.elc\"; +otherwise adds \".elc\"." (if byte-compile-dest-file-function (funcall byte-compile-dest-file-function filename) (setq filename (file-name-sans-versions |