From: Glenn Morris Date: Wed, 22 Jul 2009 02:45:34 +0000 (+0000) Subject: Remove leading * from defcustom docs. X-Git-Tag: emacs-pretest-23.1.90~2066 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=cb711556008291dc0d1425b8f0f0837b37ae8368;p=emacs.git Remove leading * from defcustom docs. --- diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 1babedfb15a..a0189b49460 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,5 +1,10 @@ 2009-07-22 Glenn Morris + * emacs-lisp/advice.el, emacs-lisp/checkdoc.el: + * emacs-lisp/debug.el, emacs-lisp/elp.el, emacs-lisp/gulp.el: + * emacs-lisp/lisp.el, emacs-lisp/pp.el, emacs-lisp/trace.el: + Remove leading * from defcustom docs. + * simple.el (blink-matching-paren-distance): Bump to 100k. (Bug#3889) * emacs-lisp/shadow.el (shadows-compare-text-p): Remove leading * from diff --git a/lisp/emacs-lisp/advice.el b/lisp/emacs-lisp/advice.el index fa5d57a854a..f9f80cdcbb6 100644 --- a/lisp/emacs-lisp/advice.el +++ b/lisp/emacs-lisp/advice.el @@ -1834,7 +1834,7 @@ ;;;###autoload (defcustom ad-redefinition-action 'warn - "*Defines what to do with redefinitions during Advice de/activation. + "Defines what to do with redefinitions during Advice de/activation. Redefinition occurs if a previously activated function that already has an original definition associated with it gets redefined and then de/activated. In such a case we can either accept the current definition as the new @@ -1849,7 +1849,7 @@ interpreted as `error'." ;;;###autoload (defcustom ad-default-compilation-action 'maybe - "*Defines whether to compile advised definitions during activation. + "Defines whether to compile advised definitions during activation. A value of `always' will result in unconditional compilation, `never' will always avoid compilation, `maybe' will compile if the byte-compiler is already loaded, and `like-original' will compile if the original definition of the diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index ca81c23d18f..fad8d25ab6b 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -183,7 +183,7 @@ :version "20.3") (defcustom checkdoc-minor-mode-string " CDoc" - "*String to display in mode line when Checkdoc mode is enabled; nil for none." + "String to display in mode line when Checkdoc mode is enabled; nil for none." :type '(choice string (const :tag "None" nil)) :group 'checkdoc :version "23.1") diff --git a/lisp/emacs-lisp/debug.el b/lisp/emacs-lisp/debug.el index f74fb5a2ea5..fcb6dfcc279 100644 --- a/lisp/emacs-lisp/debug.el +++ b/lisp/emacs-lisp/debug.el @@ -35,13 +35,13 @@ :group 'debug) (defcustom debugger-mode-hook nil - "*Hooks run when `debugger-mode' is turned on." + "Hooks run when `debugger-mode' is turned on." :type 'hook :group 'debugger :version "20.3") (defcustom debugger-batch-max-lines 40 - "*Maximum lines to show in debugger buffer in a noninteractive Emacs. + "Maximum lines to show in debugger buffer in a noninteractive Emacs. When the debugger is entered and Emacs is running in batch mode, if the backtrace text has more than this many lines, the middle is discarded, and just the beginning and end are displayed." @@ -674,7 +674,7 @@ Complete list of commands: (run-mode-hooks 'debugger-mode-hook)) (defcustom debugger-record-buffer "*Debugger-record*" - "*Buffer name for expression values, for \\[debugger-record-expression]." + "Buffer name for expression values, for \\[debugger-record-expression]." :type 'string :group 'debugger :version "20.3") diff --git a/lisp/emacs-lisp/elp.el b/lisp/emacs-lisp/elp.el index 7b3acab2f6b..756aa3c778b 100644 --- a/lisp/emacs-lisp/elp.el +++ b/lisp/emacs-lisp/elp.el @@ -133,19 +133,19 @@ :group 'lisp) (defcustom elp-function-list nil - "*List of functions to profile. + "List of functions to profile. Used by the command `elp-instrument-list'." :type '(repeat function) :group 'elp) (defcustom elp-reset-after-results t - "*Non-nil means reset all profiling info after results are displayed. + "Non-nil means reset all profiling info after results are displayed. Results are displayed with the `elp-results' command." :type 'boolean :group 'elp) (defcustom elp-sort-by-function 'elp-sort-by-total-time - "*Non-nil specifies ELP results sorting function. + "Non-nil specifies ELP results sorting function. These functions are currently available: elp-sort-by-call-count -- sort by the highest call count @@ -162,7 +162,7 @@ the symbol's name string." :group 'elp) (defcustom elp-report-limit 1 - "*Prevent some functions from being displayed in the results buffer. + "Prevent some functions from being displayed in the results buffer. If a number, no function that has been called fewer than that number of times will be displayed in the output buffer. If nil, all functions will be displayed." @@ -171,12 +171,12 @@ functions will be displayed." :group 'elp) (defcustom elp-use-standard-output nil - "*If non-nil, output to `standard-output' instead of a buffer." + "If non-nil, output to `standard-output' instead of a buffer." :type 'boolean :group 'elp) (defcustom elp-recycle-buffers-p t - "*If nil, don't recycle the `elp-results-buffer'. + "If nil, don't recycle the `elp-results-buffer'. In other words, a new unique buffer is create every time you run \\[elp-results]." :type 'boolean diff --git a/lisp/emacs-lisp/gulp.el b/lisp/emacs-lisp/gulp.el index dde710c977e..5d90919ccf3 100644 --- a/lisp/emacs-lisp/gulp.el +++ b/lisp/emacs-lisp/gulp.el @@ -35,16 +35,17 @@ :group 'maint) (defcustom gulp-discard "^;+ *Maintainer: *FSF *$" - "*The regexp matching the packages not requiring the request for updates." + "The regexp matching the packages not requiring the request for updates." :type 'regexp :group 'gulp) -(defcustom gulp-tmp-buffer "*gulp*" "The name of the temporary buffer." +(defcustom gulp-tmp-buffer "*gulp*" + "The name of the temporary buffer." :type 'string :group 'gulp) (defcustom gulp-max-len 2000 - "*Distance into a Lisp source file to scan for keywords." + "Distance into a Lisp source file to scan for keywords." :type 'integer :group 'gulp) @@ -54,7 +55,7 @@ I'm going to start pretesting a new version of GNU Emacs soon, so I'd like to ask if you have any updates for the Emacs packages you work on. You're listed as the maintainer of the following package(s):\n\n") - "*The starting text of a gulp message." + "The starting text of a gulp message." :type 'string :group 'gulp) @@ -72,7 +73,7 @@ please use lisp/ChangeLog as a guide for the style and for what kinds of information to include. Thanks.") - "*The closing text in a gulp message." + "The closing text in a gulp message." :type 'string :group 'gulp) diff --git a/lisp/emacs-lisp/lisp.el b/lisp/emacs-lisp/lisp.el index 6de82b43c3d..f586382afd3 100644 --- a/lisp/emacs-lisp/lisp.el +++ b/lisp/emacs-lisp/lisp.el @@ -30,7 +30,7 @@ ;; Note that this variable is used by non-lisp modes too. (defcustom defun-prompt-regexp nil - "*If non-nil, a regexp to ignore before a defun. + "If non-nil, a regexp to ignore before a defun. This is only necessary if the opening paren or brace is not in column 0. See function `beginning-of-defun'." :type '(choice (const nil) diff --git a/lisp/emacs-lisp/pp.el b/lisp/emacs-lisp/pp.el index bf53c9e6153..55ae740bd38 100644 --- a/lisp/emacs-lisp/pp.el +++ b/lisp/emacs-lisp/pp.el @@ -33,7 +33,7 @@ :group 'lisp) (defcustom pp-escape-newlines t - "*Value of `print-escape-newlines' used by pp-* functions." + "Value of `print-escape-newlines' used by pp-* functions." :type 'boolean :group 'pp) diff --git a/lisp/emacs-lisp/trace.el b/lisp/emacs-lisp/trace.el index d44b159752a..40c3e138264 100644 --- a/lisp/emacs-lisp/trace.el +++ b/lisp/emacs-lisp/trace.el @@ -161,7 +161,7 @@ ;;;###autoload (defcustom trace-buffer "*trace-output*" - "*Trace output will by default go to that buffer." + "Trace output will by default go to that buffer." :type 'string :group 'trace)