# HG changeset patch # User Eli Zaretskii # Date 967032312 0 # Node ID e9c859a12e4712e8fec5217dad71e95f9744a155 # Parent aa11fb167cec4cfb6434c6e15b3c4879df8b9f5e Add a comment about the significance of an asterisk as the first character of a variable's doc string. Reported by Donald Knuth. diff -r aa11fb167cec -r e9c859a12e47 lispref/help.texi --- a/lispref/help.texi Wed Aug 23 11:54:24 2000 +0000 +++ b/lispref/help.texi Wed Aug 23 12:05:12 2000 +0000 @@ -241,6 +241,11 @@ @end group @end smallexample +The asterisk @samp{*} as the first character of a variable's doc string, +as shown above for the @code{goal-column} variable, means that it is a +user option; see the description of @code{defvar} in @ref{Defining +Variables}. + @defun Snarf-documentation filename This function is used only during Emacs initialization, just before the runnable Emacs is dumped. It finds the file offsets of the