aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorChong Yidong2010-11-20 14:52:20 -0500
committerChong Yidong2010-11-20 14:52:20 -0500
commitec8a6295a0e4554f2ce8164ff3fe5e2910810d0d (patch)
tree59d16ae6eef3b8a7cdb3e7df405c83961c09373c /doc/lispref
parent8d7f026f625a02854b3214f7a54e778121d266bc (diff)
downloademacs-ec8a6295a0e4554f2ce8164ff3fe5e2910810d0d.tar.gz
emacs-ec8a6295a0e4554f2ce8164ff3fe5e2910810d0d.zip
Document some Emacs 23.3 changes in manuals.
* doc/emacs/macos.texi (Mac / GNUstep Basics): Document ns-right-alternate-modifier. * doc/lispref/numbers.texi (Float Basics): Document float-e and float-pi. * doc/lispref/symbols.texi (Creating Symbols): Using unintern without an obarray arg is now obsolete. * doc/lispref/text.texi (Kill Functions, Kill Functions) (Low-Level Kill Ring, Low-Level Kill Ring): Remove obsolete YANK-HANDLER args. * doc/lispref/variables.texi (Defining Variables): Change "pi" example to "float-pi".
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/ChangeLog14
-rw-r--r--doc/lispref/numbers.texi8
-rw-r--r--doc/lispref/symbols.texi2
-rw-r--r--doc/lispref/text.texi25
-rw-r--r--doc/lispref/variables.texi18
5 files changed, 37 insertions, 30 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 79d6f71c1b4..2ea15fe3ca8 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,17 @@
12010-11-20 Chong Yidong <cyd@stupidchicken.com>
2
3 * text.texi (Kill Functions, Kill Functions)
4 (Low-Level Kill Ring, Low-Level Kill Ring): Remove obsolete
5 YANK-HANDLER args.
6
7 * symbols.texi (Creating Symbols): Using unintern without an
8 obarray arg is now obsolete.
9
10 * numbers.texi (Float Basics): Document float-e and float-pi.
11
12 * variables.texi (Defining Variables): Change "pi" example to
13 "float-pi".
14
12010-11-12 Eli Zaretskii <eliz@gnu.org> 152010-11-12 Eli Zaretskii <eliz@gnu.org>
2 16
3 * customize.texi (Composite Types): Lower-case index entry. 17 * customize.texi (Composite Types): Lower-case index entry.
diff --git a/doc/lispref/numbers.texi b/doc/lispref/numbers.texi
index 62b4796350e..e83da348e05 100644
--- a/doc/lispref/numbers.texi
+++ b/doc/lispref/numbers.texi
@@ -224,6 +224,14 @@ down to an integer.
224@end example 224@end example
225@end defun 225@end defun
226 226
227@defvar float-e
228The mathematical constant @math{e} (2.71828@dots{}).
229@end defvar
230
231@defvar float-pi
232The mathematical constant @math{pi} (3.14159@dots{}).
233@end defvar
234
227@node Predicates on Numbers 235@node Predicates on Numbers
228@section Type Predicates for Numbers 236@section Type Predicates for Numbers
229@cindex predicates for numbers 237@cindex predicates for numbers
diff --git a/doc/lispref/symbols.texi b/doc/lispref/symbols.texi
index 5bb44ff9675..ccf90e33cd0 100644
--- a/doc/lispref/symbols.texi
+++ b/doc/lispref/symbols.texi
@@ -383,7 +383,7 @@ See @code{documentation} in @ref{Accessing Documentation}, for another
383example using @code{mapatoms}. 383example using @code{mapatoms}.
384@end defun 384@end defun
385 385
386@defun unintern symbol &optional obarray 386@defun unintern symbol obarray
387This function deletes @var{symbol} from the obarray @var{obarray}. If 387This function deletes @var{symbol} from the obarray @var{obarray}. If
388@code{symbol} is not actually in the obarray, @code{unintern} does 388@code{symbol} is not actually in the obarray, @code{unintern} does
389nothing. If @var{obarray} is @code{nil}, the current obarray is used. 389nothing. If @var{obarray} is @code{nil}, the current obarray is used.
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 2510607475b..025bf1b6f85 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -865,7 +865,7 @@ adds it to the most recent element. It determines automatically (using
865@code{last-command}) whether the previous command was a kill command, 865@code{last-command}) whether the previous command was a kill command,
866and if so appends the killed text to the most recent entry. 866and if so appends the killed text to the most recent entry.
867 867
868@deffn Command kill-region start end &optional yank-handler 868@deffn Command kill-region start end
869This function kills the text in the region defined by @var{start} and 869This function kills the text in the region defined by @var{start} and
870@var{end}. The text is deleted but saved in the kill ring, along with 870@var{end}. The text is deleted but saved in the kill ring, along with
871its text properties. The value is always @code{nil}. 871its text properties. The value is always @code{nil}.
@@ -873,17 +873,10 @@ its text properties. The value is always @code{nil}.
873In an interactive call, @var{start} and @var{end} are point and 873In an interactive call, @var{start} and @var{end} are point and
874the mark. 874the mark.
875 875
876@c Emacs 19 feature
877If the buffer or text is read-only, @code{kill-region} modifies the kill 876If the buffer or text is read-only, @code{kill-region} modifies the kill
878ring just the same, then signals an error without modifying the buffer. 877ring just the same, then signals an error without modifying the buffer.
879This is convenient because it lets the user use a series of kill 878This is convenient because it lets the user use a series of kill
880commands to copy text from a read-only buffer into the kill ring. 879commands to copy text from a read-only buffer into the kill ring.
881
882If @var{yank-handler} is non-@code{nil}, this puts that value onto
883the string of killed text, as a @code{yank-handler} text property.
884@xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, any
885@code{yank-handler} properties present on the killed text are copied
886onto the kill ring, like other text properties.
887@end deffn 880@end deffn
888 881
889@defopt kill-read-only-ok 882@defopt kill-read-only-ok
@@ -1068,7 +1061,7 @@ it returns the entry pointed at by the yanking pointer and does not
1068move the yanking pointer. 1061move the yanking pointer.
1069@end defun 1062@end defun
1070 1063
1071@defun kill-new string &optional replace yank-handler 1064@defun kill-new string &optional replace
1072This function pushes the text @var{string} onto the kill ring and 1065This function pushes the text @var{string} onto the kill ring and
1073makes the yanking pointer point to it. It discards the oldest entry 1066makes the yanking pointer point to it. It discards the oldest entry
1074if appropriate. It also invokes the value of 1067if appropriate. It also invokes the value of
@@ -1077,25 +1070,15 @@ if appropriate. It also invokes the value of
1077If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the 1070If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the
1078first element of the kill ring with @var{string}, rather than pushing 1071first element of the kill ring with @var{string}, rather than pushing
1079@var{string} onto the kill ring. 1072@var{string} onto the kill ring.
1080
1081If @var{yank-handler} is non-@code{nil}, this puts that value onto
1082the string of killed text, as a @code{yank-handler} property.
1083@xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, then
1084@code{kill-new} copies any @code{yank-handler} properties present on
1085@var{string} onto the kill ring, as it does with other text properties.
1086@end defun 1073@end defun
1087 1074
1088@defun kill-append string before-p &optional yank-handler 1075@defun kill-append string before-p
1089This function appends the text @var{string} to the first entry in the 1076This function appends the text @var{string} to the first entry in the
1090kill ring and makes the yanking pointer point to the combined entry. 1077kill ring and makes the yanking pointer point to the combined entry.
1091Normally @var{string} goes at the end of the entry, but if 1078Normally @var{string} goes at the end of the entry, but if
1092@var{before-p} is non-@code{nil}, it goes at the beginning. This 1079@var{before-p} is non-@code{nil}, it goes at the beginning. This
1093function also invokes the value of @code{interprogram-cut-function} 1080function also invokes the value of @code{interprogram-cut-function}
1094(see below). This handles @var{yank-handler} just like 1081(see below).
1095@code{kill-new}, except that if @var{yank-handler} is different from
1096the @code{yank-handler} property of the first entry of the kill ring,
1097@code{kill-append} pushes the concatenated string onto the kill ring,
1098instead of replacing the original first entry with it.
1099@end defun 1082@end defun
1100 1083
1101@defvar interprogram-paste-function 1084@defvar interprogram-paste-function
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index a3a550868f5..20fe4dbc9fa 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -544,21 +544,23 @@ not the buffer-local value. (But you should not be making
544buffer-local bindings for a symbol that is defined with 544buffer-local bindings for a symbol that is defined with
545@code{defconst}.) 545@code{defconst}.)
546 546
547Here, @code{pi} is a constant that presumably ought not to be changed 547An example of the use of @code{defconst} is Emacs' definition of
548by anyone (attempts by the Indiana State Legislature notwithstanding). 548@code{float-pi}---the mathematical constant @math{pi}, which ought not
549As the second form illustrates, however, this is only advisory. 549to be changed by anyone (attempts by the Indiana State Legislature
550notwithstanding). As the second form illustrates, however,
551@code{defconst} is only advisory.
550 552
551@example 553@example
552@group 554@group
553(defconst pi 3.1415 "Pi to five places.") 555(defconst float-pi 3.141592653589793 "The value of Pi.")
554 @result{} pi 556 @result{} float-pi
555@end group 557@end group
556@group 558@group
557(setq pi 3) 559(setq float-pi 3)
558 @result{} pi 560 @result{} float-pi
559@end group 561@end group
560@group 562@group
561pi 563float-pi
562 @result{} 3 564 @result{} 3
563@end group 565@end group
564@end example 566@end example