procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a comment about the significance of an asterisk as the first

Browse source 
character of a variable's doc string.  Reported by Donald Knuth.
This commit is contained in:
Eli Zaretskii 2000-08-23 12:05:12 +00:00
parent 9b47cfe0f3
commit bfccb7b3bc
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lispref/help.texi
View 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