Mercurial > emacs
changeset 99898:d9a2d006b717
(Defining Variables): Note that `*' is not necessary if defcustom is
used.
| author | Chong Yidong <cyd@stupidchicken.com> |
|---|---|
| date | Mon, 24 Nov 2008 23:19:29 +0000 |
| parents | ffd856998075 |
| children | 2796739a5e4f |
| files | doc/lispref/variables.texi |
| diffstat | 1 files changed, 7 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/lispref/variables.texi Mon Nov 24 23:19:22 2008 +0000 +++ b/doc/lispref/variables.texi Mon Nov 24 23:19:29 2008 +0000 @@ -457,13 +457,13 @@ stored in the symbol's @code{variable-documentation} property. The Emacs help functions (@pxref{Documentation}) look for this property. -If the variable is a user option that users would want to set -interactively, you should use @samp{*} as the first character of -@var{doc-string}. This lets users set the variable conveniently using -the @code{set-variable} command. Note that you should nearly always -use @code{defcustom} instead of @code{defvar} to define these -variables, so that users can use @kbd{M-x customize} and related -commands to set them. @xref{Customization}. +If the documentation string begins with the character @samp{*}, Emacs +allows users to set it interactively using the @code{set-variable} +command. However, you should nearly always use @code{defcustom} +instead of @code{defvar} to define such variables, so that users can +use @kbd{M-x customize} and related commands to set them. In that +case, it is not necessary to begin the documentation string with +@samp{*}. @xref{Customization}. Here are some examples. This form defines @code{foo} but does not initialize it: