From bfccb7b3bc8579f8221c126e9482ad418ce38677 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Wed, 23 Aug 2000 12:05:12 +0000 Subject: [PATCH] Add a comment about the significance of an asterisk as the first character of a variable's doc string. Reported by Donald Knuth. --- lispref/help.texi | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lispref/help.texi b/lispref/help.texi index 12beaf2e29f..eeb8d998755 100644 --- a/lispref/help.texi +++ b/lispref/help.texi @@ -241,6 +241,11 @@ When the `track-eol' feature is doing its job, the value is 9999. @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 -- 2.39.2