]> git.eshelyaron.com Git - emacs.git/commitdiff
Add a comment about the significance of an asterisk as the first
authorEli Zaretskii <eliz@gnu.org>
Wed, 23 Aug 2000 12:05:12 +0000 (12:05 +0000)
committerEli Zaretskii <eliz@gnu.org>
Wed, 23 Aug 2000 12:05:12 +0000 (12:05 +0000)
character of a variable's doc string.  Reported by Donald Knuth.

lispref/help.texi

index 12beaf2e29f5784e357a9ca017018cb6c6c2081e..eeb8d9987557bcbd92e412a199eb9343d14f05f3 100644 (file)
@@ -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