aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2012-10-30 00:54:17 -0700
committerGlenn Morris2012-10-30 00:54:17 -0700
commit516e1a08ce36fca220a0eaead731d3fe2d3bb271 (patch)
tree4666aaeb1ed16e5669f0ad483772923791bf3f44
parent4ddedf94c8529de0c13b74c1156d89872f94c155 (diff)
downloademacs-516e1a08ce36fca220a0eaead731d3fe2d3bb271.tar.gz
emacs-516e1a08ce36fca220a0eaead731d3fe2d3bb271.zip
More small manual updates for cl.texi
* doc/misc/cl.texi (Setf Extensions): Partially restore note about cl-getf, mainly moved to lispref/variables.texi. (Property Lists): Fix cl-getf typos. * doc/lispref/variables.texi (Generalized Variables): Fix typo.
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/variables.texi8
-rw-r--r--doc/misc/ChangeLog3
-rw-r--r--doc/misc/cl.texi13
4 files changed, 19 insertions, 9 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 2309cde2998..eca39e54203 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12012-10-30 Glenn Morris <rgm@gnu.org>
2
3 * variables.texi (Generalized Variables): Fix typo.
4
12012-10-30 Chong Yidong <cyd@gnu.org> 52012-10-30 Chong Yidong <cyd@gnu.org>
2 6
3 * symbols.texi (Symbol Plists): Document function-get. 7 * symbols.texi (Symbol Plists): Document function-get.
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 1ffb1f7ffcb..580dd8258df 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -2025,10 +2025,10 @@ process-filter
2025Using any forms other than these in the @var{place} argument to 2025Using any forms other than these in the @var{place} argument to
2026@code{setf} will signal an error. 2026@code{setf} will signal an error.
2027 2027
2028Note that for @code{nthcdr} and @code{getf}, the list argument 2028@c And for cl-lib's cl-getf.
2029of the function must itself be a valid @var{place} form. For 2029Note that for @code{nthcdr}, the list argument of the function must
2030example, @code{(setf (nthcdr 0 foo) 7)} will set @code{foo} itself 2030itself be a valid @var{place} form. For example, @code{(setf (nthcdr
2031to 7. 20310 foo) 7)} will set @code{foo} itself to 7.
2032@c The use of @code{nthcdr} as a @var{place} form is an extension 2032@c The use of @code{nthcdr} as a @var{place} form is an extension
2033@c to standard Common Lisp. 2033@c to standard Common Lisp.
2034 2034
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index b07db9d605f..fa58cd958db 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -2,6 +2,9 @@
2 2
3 * cl.texi (Modify Macros): Update for cl-letf changes. 3 * cl.texi (Modify Macros): Update for cl-letf changes.
4 (Obsolete Lexical Macros): Say a little more about letf/cl-letf. 4 (Obsolete Lexical Macros): Say a little more about letf/cl-letf.
5 (Setf Extensions): Partially restore note about cl-getf,
6 mainly moved to lispref/variables.texi.
7 (Property Lists): Fix cl-getf typos.
5 8
62012-10-29 Glenn Morris <rgm@gnu.org> 92012-10-29 Glenn Morris <rgm@gnu.org>
7 10
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index f520144679e..4105ac349ec 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -900,6 +900,10 @@ cl-caaar .. cl-cddddr cl-first .. cl-tenth
900cl-rest cl-get cl-getf cl-subseq 900cl-rest cl-get cl-getf cl-subseq
901@end smallexample 901@end smallexample
902 902
903@noindent
904Note that for @code{cl-getf} (as for @code{nthcdr}), the list argument
905of the function must itself be a valid @var{place} form.
906
903@item 907@item
904General Emacs Lisp functions: 908General Emacs Lisp functions:
905@smallexample 909@smallexample
@@ -2813,10 +2817,10 @@ is given).
2813In particular, 2817In particular,
2814 2818
2815@example 2819@example
2816(get sym prop) @equiv{} (cl-get (symbol-plist sym) prop) 2820(get sym prop) @equiv{} (cl-getf (symbol-plist sym) prop)
2817@end example 2821@end example
2818 2822
2819It is valid to use @code{getf} as a @code{setf} place, in which case 2823It is valid to use @code{cl-getf} as a @code{setf} place, in which case
2820its @var{place} argument must itself be a valid @code{setf} place. 2824its @var{place} argument must itself be a valid @code{setf} place.
2821The @var{default} argument, if any, is ignored in this context. 2825The @var{default} argument, if any, is ignored in this context.
2822The effect is to change (via @code{setcar}) the value cell in the 2826The effect is to change (via @code{setcar}) the value cell in the
@@ -2824,7 +2828,7 @@ list that corresponds to @var{property}, or to cons a new property-value
2824pair onto the list if the property is not yet present. 2828pair onto the list if the property is not yet present.
2825 2829
2826@example 2830@example
2827(put sym prop val) @equiv{} (setf (cl-get (symbol-plist sym) prop) val) 2831(put sym prop val) @equiv{} (setf (cl-getf (symbol-plist sym) prop) val)
2828@end example 2832@end example
2829 2833
2830The @code{get} and @code{cl-get} functions are also @code{setf}-able. 2834The @code{get} and @code{cl-get} functions are also @code{setf}-able.
@@ -2837,8 +2841,7 @@ The fact that @code{default} is ignored can sometimes be useful:
2837Here, symbol @code{foo}'s @code{usage-count} property is incremented 2841Here, symbol @code{foo}'s @code{usage-count} property is incremented
2838if it exists, or set to 1 (an incremented 0) otherwise. 2842if it exists, or set to 1 (an incremented 0) otherwise.
2839 2843
2840@c FIXME cl-getf? 2844When not used as a @code{setf} form, @code{cl-getf} is just a regular
2841When not used as a @code{setf} form, @code{getf} is just a regular
2842function and its @var{place} argument can actually be any Lisp 2845function and its @var{place} argument can actually be any Lisp
2843expression. 2846expression.
2844@end defun 2847@end defun