aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2000-08-23 12:05:12 +0000
committerEli Zaretskii2000-08-23 12:05:12 +0000
commitbfccb7b3bc8579f8221c126e9482ad418ce38677 (patch)
treeea71762efe6cbce513bf031b7aab3dd881ef9ead
parent9b47cfe0f37110b674fc7153cebad252bd3d3539 (diff)
downloademacs-bfccb7b3bc8579f8221c126e9482ad418ce38677.tar.gz
emacs-bfccb7b3bc8579f8221c126e9482ad418ce38677.zip
Add a comment about the significance of an asterisk as the first
character of a variable's doc string. Reported by Donald Knuth.
-rw-r--r--lispref/help.texi5
1 files changed, 5 insertions, 0 deletions
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.
241@end group 241@end group
242@end smallexample 242@end smallexample
243 243
244The asterisk @samp{*} as the first character of a variable's doc string,
245as shown above for the @code{goal-column} variable, means that it is a
246user option; see the description of @code{defvar} in @ref{Defining
247Variables}.
248
244@defun Snarf-documentation filename 249@defun Snarf-documentation filename
245This function is used only during Emacs initialization, just before 250This function is used only during Emacs initialization, just before
246the runnable Emacs is dumped. It finds the file offsets of the 251the runnable Emacs is dumped. It finds the file offsets of the