procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

A few small doc fixes for bytecomp.el

Browse source 
* lisp/emacs-lisp/bytecomp.el (emacs-lisp-file-regexp)
(byte-compile-dest-file-function, byte-compile-dest-file): Doc fixes.
This commit is contained in:
Glenn Morris 2017-11-27 14:10:34 -05:00
parent 37f3a6b216
commit 1c8bd8a119
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
lisp/emacs-lisp/bytecomp.el
View file

@ -144,14 +144,20 @@
(defcustom emacs-lisp-file-regexp "\\.el\\'" (defcustom emacs-lisp-file-regexp "\\.el\\'"
"Regexp which matches Emacs Lisp source files. "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 :group 'bytecomp
:type 'regexp) :type 'regexp)
(defcustom byte-compile-dest-file-function nil (defcustom byte-compile-dest-file-function nil
"Function for the function `byte-compile-dest-file' to call. "Function for the function `byte-compile-dest-file' to call.
It should take one argument, the name of an Emacs Lisp source 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 :group 'bytecomp
:type '(choice (const nil) function) :type '(choice (const nil) function)
:version "23.2") :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. "Convert an Emacs Lisp source file name to a compiled file name.
If `byte-compile-dest-file-function' is non-nil, uses that If `byte-compile-dest-file-function' is non-nil, uses that
function to do the work. Otherwise, if FILENAME matches function to do the work. Otherwise, if FILENAME matches
`emacs-lisp-file-regexp' (by default, files with the extension `.el'), `emacs-lisp-file-regexp' (by default, files with the extension \".el\"),
adds `c' to it; otherwise adds `.elc'." replaces the matching part (and anything after it) with \"\.elc\";
otherwise adds \".elc\"."
(if byte-compile-dest-file-function (if byte-compile-dest-file-function
(funcall byte-compile-dest-file-function filename) (funcall byte-compile-dest-file-function filename)
(setq filename (file-name-sans-versions (setq filename (file-name-sans-versions