Mercurial > hg > xemacs-beta

comparison man/lispref/compile.texi @ 444:576fb035e263 r21-2-37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-37
author cvs
date Mon, 13 Aug 2007 11:36:19 +0200
parents abe6d1db359e
children 1ccc32a20af4
comparison
equal deleted inserted replaced
443:a8296e22da4e 444:576fb035e263
211 @end group 211 @end group
212 @end example 212 @end example
213 @end deffn 213 @end deffn
214 214
215 @c flag is not optional in FSF Emacs 215 @c flag is not optional in FSF Emacs
216 @deffn Command byte-recompile-directory directory &optional flag 216 @deffn Command byte-recompile-directory directory &optional flag norecursion force
217 @cindex library compilation 217 @cindex library compilation
218 This function recompiles every @samp{.el} file in @var{directory} that 218 This function recompiles every @samp{.el} file in @var{directory} that
219 needs recompilation. A file needs recompilation if a @samp{.elc} file 219 needs recompilation. A file needs recompilation if a @samp{.elc} file
220 exists but is older than the @samp{.el} file. 220 exists but is older than the @samp{.el} file.
221 221
222 Files in subdirectories of @var{directory} are also processed unless
223 optional argument @var{norecursion} is non-@code{nil}.
224
222 When a @samp{.el} file has no corresponding @samp{.elc} file, then 225 When a @samp{.el} file has no corresponding @samp{.elc} file, then
223 @var{flag} says what to do. If it is @code{nil}, these files are 226 @var{flag} says what to do. If it is @code{nil}, these files are
224 ignored. If it is non-@code{nil}, the user is asked whether to compile 227 ignored. If it is non-@code{nil}, the user is asked whether to compile
225 each such file. 228 each such file.
229
230 If the fourth optional argument @var{force} is non-@code{nil},
231 recompile every @samp{.el} file that already has a @samp{.elc} file.
226 232
227 The return value of this command is unpredictable. 233 The return value of this command is unpredictable.
228 @end deffn 234 @end deffn
229 235
230 @defun batch-byte-compile 236 @defun batch-byte-compile
252 will continue compiling even when an error occurs in a file. This is 258 will continue compiling even when an error occurs in a file. This is
253 normally @code{nil}, but is bound to @code{t} by 259 normally @code{nil}, but is bound to @code{t} by
254 @code{batch-byte-recompile-directory}. 260 @code{batch-byte-recompile-directory}.
255 @end defvar 261 @end defvar
256 262
257 @defun byte-code instructions constants stack-size 263 @defun byte-code instructions constants stack-depth
258 @cindex byte-code interpreter 264 @cindex byte-code interpreter
259 This function actually interprets byte-code. 265 This function actually interprets byte-code.
260 Don't call this function yourself. Only the byte compiler knows how to 266 Don't call this function yourself. Only the byte compiler knows how to
261 generate valid calls to this function. 267 generate valid calls to this function.
262 268
449 455
450 @item constants 456 @item constants
451 The vector of Lisp objects referenced by the byte code. These include 457 The vector of Lisp objects referenced by the byte code. These include
452 symbols used as function names and variable names. 458 symbols used as function names and variable names.
453 459
454 @item stack-size 460 @item stack-depth
455 The maximum stack size this function needs. 461 The maximum stack size this function needs.
456 462
457 @item doc-string 463 @item doc-string
458 The documentation string (if any); otherwise, @code{nil}. The value may 464 The documentation string (if any); otherwise, @code{nil}. The value may
459 be a number or a list, in case the documentation string is stored in a 465 be a number or a list, in case the documentation string is stored in a
483 @end example 489 @end example
484 490
485 The primitive way to create a compiled-function object is with 491 The primitive way to create a compiled-function object is with
486 @code{make-byte-code}: 492 @code{make-byte-code}:
487 493
488 @defun make-byte-code arglist instructions constants stack-size &optional doc-string interactive 494 @defun make-byte-code arglist instructions constants stack-depth &optional doc-string interactive
489 This function constructs and returns a compiled-function object 495 This function constructs and returns a compiled-function object
490 with the specified attributes. 496 with the specified attributes.
491 497
492 @emph{Please note:} Unlike all other Emacs-lisp functions, calling this with 498 @emph{Please note:} Unlike all other Emacs-lisp functions, calling this with
493 five arguments is @emph{not} the same as calling it with six arguments, 499 five arguments is @emph{not} the same as calling it with six arguments,
520 @defun compiled-function-constants function 526 @defun compiled-function-constants function
521 This function returns the vector of Lisp objects referenced by 527 This function returns the vector of Lisp objects referenced by
522 compiled-function object @var{function}. 528 compiled-function object @var{function}.
523 @end defun 529 @end defun
524 530
525 @defun compiled-function-stack-size function 531 @defun compiled-function-stack-depth function
526 This function returns the maximum stack size needed by compiled-function 532 This function returns the maximum stack size needed by compiled-function
527 object @var{function}. 533 object @var{function}.
528 @end defun 534 @end defun
529 535
530 @defun compiled-function-doc-string function 536 @defun compiled-function-doc-string function