aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGlenn Morris2012-11-06 20:37:07 -0800
committerGlenn Morris2012-11-06 20:37:07 -0800
commit2ee1d59f5bea4a206595d621dcb63477461b7155 (patch)
tree11e77e75f9dd809295149af72e46b8044675b899 /doc
parentb715ed4447b025d713fc68a7af3728c2d463974b (diff)
downloademacs-2ee1d59f5bea4a206595d621dcb63477461b7155.tar.gz
emacs-2ee1d59f5bea4a206595d621dcb63477461b7155.zip
Small doc updates for generalized variables
* lisp/emacs-lisp/gv.el (gv-letplace): Fix doc typo. (gv-define-simple-setter): Update doc of `fix-return'. * doc/lispref/variables.texi (Adding Generalized Variables): Update description of FIX-RETURN expansion. * doc/misc/cl.texi (Obsolete Setf Customization): Revert defsetf example to the more correct let rather than prog1.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog5
-rw-r--r--doc/lispref/variables.texi9
-rw-r--r--doc/misc/ChangeLog5
-rw-r--r--doc/misc/cl.texi10
4 files changed, 22 insertions, 7 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index c588e81dd1f..6e7a0b7a648 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
12012-11-07 Glenn Morris <rgm@gnu.org>
2
3 * variables.texi (Adding Generalized Variables):
4 Update description of FIX-RETURN expansion.
5
12012-11-06 Glenn Morris <rgm@gnu.org> 62012-11-06 Glenn Morris <rgm@gnu.org>
2 7
3 * variables.texi (Setting Generalized Variables): 8 * variables.texi (Setting Generalized Variables):
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index a7134af20bd..fb98b3cd035 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -2089,8 +2089,13 @@ no problem with, e.g., @code{car} and @code{setcar}, because
2089@code{setcar} returns the value that it set. If your @var{setter} 2089@code{setcar} returns the value that it set. If your @var{setter}
2090function does not return @var{value}, use a non-@code{nil} value for 2090function does not return @var{value}, use a non-@code{nil} value for
2091the @var{fix-return} argument of @code{gv-define-simple-setter}. This 2091the @var{fix-return} argument of @code{gv-define-simple-setter}. This
2092wraps the @code{setf} expansion in @code{(prog1 @var{value} @dots{})} 2092expands into something equivalent to
2093so that it returns the correct result. 2093@example
2094(let ((temp @var{value}))
2095 (@var{setter} @var{args}@dots{} temp)
2096 temp)
2097@end example
2098so ensuring that it returns the correct result.
2094@end defmac 2099@end defmac
2095 2100
2096 2101
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index bd815e3df9f..49f86ef093b 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
12012-11-07 Glenn Morris <rgm@gnu.org>
2
3 * cl.texi (Obsolete Setf Customization):
4 Revert defsetf example to the more correct let rather than prog1.
5
12012-11-06 Glenn Morris <rgm@gnu.org> 62012-11-06 Glenn Morris <rgm@gnu.org>
2 7
3 * cl.texi (Overview): Mention EIEIO here, as well as the appendix. 8 * cl.texi (Overview): Mention EIEIO here, as well as the appendix.
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index a5a696b6b16..e39186c1222 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -4950,9 +4950,8 @@ is completely irregular.
4950@end defmac 4950@end defmac
4951 4951
4952@defmac defsetf access-fn update-fn 4952@defmac defsetf access-fn update-fn
4953This is the simpler of two @code{defsetf} forms, and is entirely 4953This is the simpler of two @code{defsetf} forms, and is
4954obsolete, being replaced by @code{gv-define-simple-setter} in Emacs 4954replaced by @code{gv-define-simple-setter} in Emacs 24.3.
495524.3.
4956@xref{Adding Generalized Variables,,,elisp,GNU Emacs Lisp Reference Manual}. 4955@xref{Adding Generalized Variables,,,elisp,GNU Emacs Lisp Reference Manual}.
4957 4956
4958Where @var{access-fn} is the name of a function that accesses a place, 4957Where @var{access-fn} is the name of a function that accesses a place,
@@ -4983,8 +4982,9 @@ not suitable, so that the above @code{setf} should be expanded to
4983something more like 4982something more like
4984 4983
4985@example 4984@example
4986(prog1 @var{value} 4985(let ((temp @var{value}))
4987 (@var{update-fn} @var{arg1} @var{arg2} @var{arg3} @var{value})) 4986 (@var{update-fn} @var{arg1} @var{arg2} @var{arg3} temp)
4987 temp)
4988@end example 4988@end example
4989 4989
4990Some examples are: 4990Some examples are: