mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2025-02-03 20:24:29 +00:00
Add a comment about the significance of an asterisk as the first
character of a variable's doc string. Reported by Donald Knuth.
This commit is contained in:
parent
9b47cfe0f3
commit
bfccb7b3bc
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user