changeset 42436:99f8742109a3

Improve previous change.
author Richard M. Stallman <rms@gnu.org>
date Sun, 30 Dec 2001 20:11:26 +0000
parents 36047fca69b3
children 5426f6a09f35
files lispref/abbrevs.texi
diffstat 1 files changed, 10 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/abbrevs.texi	Sun Dec 30 20:07:27 2001 +0000
+++ b/lispref/abbrevs.texi	Sun Dec 30 20:11:26 2001 +0000
@@ -111,8 +111,9 @@
 
   These functions define an abbrev in a specified abbrev table.
 @code{define-abbrev} is the low-level basic function, while
-@code{add-abbrev} is used by commands that ask for information from the
-user.
+@code{add-abbrev} is used by commands that ask for information from
+the user.  When major modes predefine standard abbrevs, they should
+call @code{define-abbrev} and specify @code{t} for @var{system-flag}.
 
 @defun add-abbrev table type arg
 This function adds an abbreviation to abbrev table @var{table} based on
@@ -156,12 +157,14 @@
 @code{expand-abbrev} also returns @code{nil}, as if expansion had not
 really occurred.
 
+If @var{system-flag} is non-@code{nil}, that marks the abbrev as a
+``system'' abbrev with the @code{system-type} property.
+
 Normally the function @code{define-abbrev} sets the variable
-@code{abbrevs-changed} to @code{t}.  But if @var{system-flag} is
-non-@code{nil}, that says the abbrev is a ``system'' abbrev.  In that
-case, @code{define-abbrev} does not alter @code{abbrevs-changed}.
-Instead it marks the abbrev as a ``system'' abbrev with the
-@code{system-type} property.
+@code{abbrevs-changed} to @code{t}, if it actually changes the abbrev.
+(This is so that some commands will offer to save the abbrevs.)  It
+does not do this for a ``system'' abbrev, since those won't be saved
+anyway.
 @end defun
 
 @defopt only-global-abbrevs