Commit 2b9c3b12 authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

* emacs-lisp/bytecomp.el (byte-compile-dynamic-docstrings)

  (byte-compile-output-docform): Reflow docstrings.
  (no-byte-compile): Fix typo in docstring.
  (byte-recompile-directory, compile-defun): Doc fixes.
  (emacs-lisp-file-regexp, byte-compile-verbose)
  (byte-compile-compatibility, byte-optimize, byte-compile-delete-errors)
  (byte-compile-dynamic-docstrings, byte-optimize-log)
  (byte-compile-error-on-warn, byte-compile-warnings)
  (byte-compile-generate-call-tree, byte-compile-call-tree-sort):
  Remove * from defcustom docstrings.
parent f6ef1e65
2008-11-20 Juanma Barranquero <lekktu@gmail.com>
* emacs-lisp/bytecomp.el (byte-compile-dynamic-docstrings)
(byte-compile-output-docform): Reflow docstrings.
(no-byte-compile): Fix typo in docstring.
(byte-recompile-directory, compile-defun): Doc fixes.
(emacs-lisp-file-regexp, byte-compile-verbose)
(byte-compile-compatibility, byte-optimize, byte-compile-delete-errors)
(byte-compile-dynamic-docstrings, byte-optimize-log)
(byte-compile-error-on-warn, byte-compile-warnings)
(byte-compile-generate-call-tree, byte-compile-call-tree-sort):
Remove * from defcustom docstrings.
2008-11-20 Glenn Morris <rgm@gnu.org>
* format.el (format-alist, format-write-file): Doc fix.
......
......@@ -198,7 +198,7 @@
:group 'lisp)
(defcustom emacs-lisp-file-regexp "\\.el$"
"*Regexp which matches Emacs Lisp source files.
"Regexp which matches Emacs Lisp source files.
You may want to redefine the function `byte-compile-dest-file'
if you change this variable."
:group 'bytecomp
......@@ -244,12 +244,12 @@ with the extension `.el'), add `c' to it; otherwise add `.elc'."
(defcustom byte-compile-verbose
(and (not noninteractive) (> baud-rate search-slow-speed))
"*Non-nil means print messages describing progress of byte-compiler."
"Non-nil means print messages describing progress of byte-compiler."
:group 'bytecomp
:type 'boolean)
(defcustom byte-compile-compatibility nil
"*Non-nil means generate output that can run in Emacs 18.
"Non-nil means generate output that can run in Emacs 18.
This only means that it can run in principle, if it doesn't require
facilities that have been added more recently."
:group 'bytecomp
......@@ -263,7 +263,7 @@ facilities that have been added more recently."
;; this way can never be run in Emacs 18, and may even cause it to crash.")
(defcustom byte-optimize t
"*Enable optimization in the byte compiler.
"Enable optimization in the byte compiler.
Possible values are:
nil - no optimization
t - all optimizations
......@@ -276,7 +276,7 @@ Possible values are:
(const :tag "byte-level" byte)))
(defcustom byte-compile-delete-errors nil
"*If non-nil, the optimizer may delete forms that may signal an error.
"If non-nil, the optimizer may delete forms that may signal an error.
This includes variable references and calls to functions such as `car'."
:group 'bytecomp
:type 'boolean)
......@@ -300,10 +300,9 @@ the functions you loaded will not be able to run.")
;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
(defcustom byte-compile-dynamic-docstrings t
"*If non-nil, compile doc strings for lazy access.
We bury the doc strings of functions and variables
inside comments in the file, and bring them into core only when they
are actually needed.
"If non-nil, compile doc strings for lazy access.
We bury the doc strings of functions and variables inside comments in
the file, and bring them into core only when they are actually needed.
When this option is true, if you load the compiled file and then move it,
you won't be able to find the documentation of anything in that file.
......@@ -319,7 +318,7 @@ This option is enabled by default because it reduces Emacs memory usage."
;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
(defcustom byte-optimize-log nil
"*If true, the byte-compiler will log its optimizations into *Compile-Log*.
"If true, the byte-compiler will log its optimizations into *Compile-Log*.
If this is 'source, then only source-level optimizations will be logged.
If it is 'byte, then only byte-level optimizations will be logged."
:group 'bytecomp
......@@ -329,7 +328,7 @@ If it is 'byte, then only byte-level optimizations will be logged."
(const :tag "byte-level" byte)))
(defcustom byte-compile-error-on-warn nil
"*If true, the byte-compiler reports warnings with `error'."
"If true, the byte-compiler reports warnings with `error'."
:group 'bytecomp
:type 'boolean)
......@@ -339,7 +338,7 @@ If it is 'byte, then only byte-level optimizations will be logged."
make-local mapcar)
"The list of warning types used when `byte-compile-warnings' is t.")
(defcustom byte-compile-warnings t
"*List of warnings that the byte-compiler should issue (t for all).
"List of warnings that the byte-compiler should issue (t for all).
Elements of the list may be:
......@@ -433,7 +432,7 @@ else the global value will be modified."
"If non-nil, this is a variable that shouldn't be reported as obsolete.")
(defcustom byte-compile-generate-call-tree nil
"*Non-nil means collect call-graph information when compiling.
"Non-nil means collect call-graph information when compiling.
This records which functions were called and from where.
If the value is t, compilation displays the call graph when it finishes.
If the value is neither t nor nil, compilation asks you whether to display
......@@ -450,7 +449,8 @@ invoked interactively are excluded from this list."
:type '(choice (const :tag "Yes" t) (const :tag "No" nil)
(other :tag "Ask" lambda)))
(defvar byte-compile-call-tree nil "Alist of functions and their call tree.
(defvar byte-compile-call-tree nil
"Alist of functions and their call tree.
Each element looks like
\(FUNCTION CALLERS CALLS\)
......@@ -460,7 +460,7 @@ is a list of functions for which calls were generated while compiling
FUNCTION.")
(defcustom byte-compile-call-tree-sort 'name
"*If non-nil, sort the call tree.
"If non-nil, sort the call tree.
The values `name', `callers', `calls', `calls+callers'
specify different fields to sort on."
:group 'bytecomp
......@@ -1586,7 +1586,7 @@ Files in subdirectories of DIRECTORY are processed also."
(defun byte-recompile-directory (bytecomp-directory &optional bytecomp-arg
bytecomp-force)
"Recompile every `.el' file in BYTECOMP-DIRECTORY that needs recompilation.
This is if a `.elc' file exists but is older than the `.el' file.
This happens when a `.elc' file exists but is older than the `.el' file.
Files in subdirectories of BYTECOMP-DIRECTORY are processed also.
If the `.elc' file does not exist, normally this function *does not*
......@@ -1677,7 +1677,7 @@ that already has a `.elc' file."
(format " in %d directories" dir-count) "")))))
(defvar no-byte-compile nil
"Non-nil to prevent byte-compiling of emacs-lisp code.
"Non-nil to prevent byte-compiling of Emacs Lisp code.
This is normally set in local file variables at the end of the elisp file:
;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
......@@ -1842,7 +1842,7 @@ The value is non-nil if there were no errors, nil if errors."
(defun compile-defun (&optional arg)
"Compile and evaluate the current top-level form.
Print the result in the echo area.
With argument, insert value in current buffer after the form."
With argument ARG, insert value in current buffer after the form."
(interactive "P")
(save-excursion
(end-of-defun)
......@@ -2096,8 +2096,8 @@ If PREFACE and NAME are non-nil, print them too,
before INFO and the FORM but after the doc string itself.
If SPECINDEX is non-nil, it is the index in FORM
of the function bytecode string. In that case,
we output that argument and the following argument (the constants vector)
together, for lazy loading.
we output that argument and the following argument
\(the constants vector) together, for lazy loading.
QUOTED says that we have to put a quote before the
list that represents a doc string reference.
`autoload' and `custom-declare-variable' need that."
......@@ -3316,7 +3316,7 @@ That command is designed for interactive use only" fn))
((= 2 len)
(byte-compile-form (cadr form))
(byte-compile-out 'byte-negate 0))
((= 3 len)
((= 3 len)
(byte-compile-form (nth 1 form))
(byte-compile-form (nth 2 form))
(byte-compile-out 'byte-diff 0))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment