aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChong Yidong2012-10-30 08:29:37 +0800
committerChong Yidong2012-10-30 08:29:37 +0800
commite29e39c9c6aee68a50fef5149cc3acdfa74fec72 (patch)
treec88836ed25faf44771754698c5508fcffb2b96d7
parentfc83c2de544c15ce8e4e8fc7c6dd68cc4956a457 (diff)
downloademacs-e29e39c9c6aee68a50fef5149cc3acdfa74fec72.tar.gz
emacs-e29e39c9c6aee68a50fef5149cc3acdfa74fec72.zip
Document more Emacs 24.3 changes.
* frames.texi (Visibility of Frames): Document tty-top-frame. * loading.texi (Autoload): Document autoloadp, autoload-do-load. * symbols.texi (Symbol Plists): Document function-get.
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/frames.texi23
-rw-r--r--doc/lispref/loading.texi38
-rw-r--r--doc/lispref/symbols.texi6
-rw-r--r--etc/NEWS6
5 files changed, 68 insertions, 13 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 6b3febba631..2309cde2998 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,11 @@
12012-10-30 Chong Yidong <cyd@gnu.org>
2
3 * symbols.texi (Symbol Plists): Document function-get.
4
5 * loading.texi (Autoload): Document autoloadp, autoload-do-load.
6
7 * frames.texi (Visibility of Frames): Document tty-top-frame.
8
12012-10-28 Stefan Monnier <monnier@iro.umontreal.ca> 92012-10-28 Stefan Monnier <monnier@iro.umontreal.ca>
2 10
3 * keymaps.texi (Format of Keymaps): Document the multiple 11 * keymaps.texi (Format of Keymaps): Document the multiple
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 665b75048f3..f58d62675e5 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -1493,8 +1493,9 @@ This function returns the visibility status of frame @var{frame}. The
1493value is @code{t} if @var{frame} is visible, @code{nil} if it is 1493value is @code{t} if @var{frame} is visible, @code{nil} if it is
1494invisible, and @code{icon} if it is iconified. 1494invisible, and @code{icon} if it is iconified.
1495 1495
1496On a text terminal, all frames are considered visible, whether they 1496On a text terminal, all frames are considered ``visible'' for the
1497are currently being displayed or not. 1497purposes of this function, even though only one frame is displayed.
1498@xref{Raising and Lowering}.
1498@end defun 1499@end defun
1499 1500
1500@deffn Command iconify-frame &optional frame 1501@deffn Command iconify-frame &optional frame
@@ -1550,9 +1551,21 @@ If this is non-@code{nil}, activation of the minibuffer raises the frame
1550that the minibuffer window is in. 1551that the minibuffer window is in.
1551@end defopt 1552@end defopt
1552 1553
1553You can also enable auto-raise (raising automatically when a frame is 1554 On window systems, you can also enable auto-raising (on frame
1554selected) or auto-lower (lowering automatically when it is deselected) 1555selection) or auto-lowering (on frame deselection) using frame
1555for any frame using frame parameters. @xref{Management Parameters}. 1556parameters. @xref{Management Parameters}.
1557
1558@cindex top frame
1559 The concept of raising and lowering frames also applies to text
1560terminal frames. On each text terminal, only the top frame is
1561displayed at any one time.
1562
1563@defun tty-top-frame terminal
1564This function returns the top frame on @var{terminal}. @var{terminal}
1565should be a terminal object, a frame (meaning that frame's terminal),
1566or @code{nil} (meaning the selected frame's terminal). If it does not
1567refer to a text terminal, the return value is @code{nil}.
1568@end defun
1556 1569
1557@node Frame Configurations 1570@node Frame Configurations
1558@section Frame Configurations 1571@section Frame Configurations
diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi
index 77a31cfde7a..6a18bea2977 100644
--- a/doc/lispref/loading.texi
+++ b/doc/lispref/loading.texi
@@ -408,9 +408,9 @@ to load automatically from @var{filename}. The string @var{filename}
408specifies the file to load to get the real definition of @var{function}. 408specifies the file to load to get the real definition of @var{function}.
409 409
410If @var{filename} does not contain either a directory name, or the 410If @var{filename} does not contain either a directory name, or the
411suffix @code{.el} or @code{.elc}, then @code{autoload} insists on adding 411suffix @code{.el} or @code{.elc}, this function insists on adding one
412one of these suffixes, and it will not load from a file whose name is 412of these suffixes, and it will not load from a file whose name is just
413just @var{filename} with no added suffix. (The variable 413@var{filename} with no added suffix. (The variable
414@code{load-suffixes} specifies the exact required suffixes.) 414@code{load-suffixes} specifies the exact required suffixes.)
415 415
416The argument @var{docstring} is the documentation string for the 416The argument @var{docstring} is the documentation string for the
@@ -442,10 +442,11 @@ and calls @code{define-key}; not even if the variable name is the same
442symbol @var{function}. 442symbol @var{function}.
443 443
444@cindex function cell in autoload 444@cindex function cell in autoload
445If @var{function} already has a non-void function definition that is not 445if @var{function} already has non-void function definition that is not
446an autoload object, @code{autoload} does nothing and returns @code{nil}. 446an autoload object, this function does nothing and returns @code{nil}.
447If the function cell of @var{function} is void, or is already an autoload 447Otherwise, it constructs an autoload object (@pxref{Autoload Type}),
448object, then it is defined as an autoload object like this: 448and stores it as the function definition for @var{function}. The
449autoload object has this form:
449 450
450@example 451@example
451(autoload @var{filename} @var{docstring} @var{interactive} @var{type}) 452(autoload @var{filename} @var{docstring} @var{interactive} @var{type})
@@ -468,6 +469,16 @@ refers to the documentation string in the
468not a macro or a keymap. 469not a macro or a keymap.
469@end defun 470@end defun
470 471
472@defun autoloadp object
473This function returns non-@code{nil} if @var{object} is an autoload
474object. For example, to check if @code{run-prolog} is defined as an
475autoloaded function, evaluate
476
477@smallexample
478(autoloadp (symbol-function 'run-prolog))
479@end smallexample
480@end defun
481
471@cindex autoload errors 482@cindex autoload errors
472 The autoloaded file usually contains other definitions and may require 483 The autoloaded file usually contains other definitions and may require
473or provide one or more features. If the file is not completely loaded 484or provide one or more features. If the file is not completely loaded
@@ -599,6 +610,19 @@ override that, e.g., in the ``Local Variables'' section of a
599assumed to contain a trailer starting with a formfeed character. 610assumed to contain a trailer starting with a formfeed character.
600@end defvar 611@end defvar
601 612
613 The following function may be used to explicitly load the library
614specified by an autoload object:
615
616@defun autoload-do-load autoload &optional name macro-only
617This function performs the loading specified by @var{autoload}, which
618whould be an autoload object. The optional argument @var{name}, if
619non-@code{nil}, should be a symbol whose function value is
620@var{autoload}; in that case, the return value of this function is the
621symbol's new function value. If the value of the optional argument
622@var{macro-only} is @code{macro}, this function avoids loading a
623function, only a macro.
624@end defun
625
602@node Repeated Loading 626@node Repeated Loading
603@section Repeated Loading 627@section Repeated Loading
604@cindex repeated loading 628@cindex repeated loading
diff --git a/doc/lispref/symbols.texi b/doc/lispref/symbols.texi
index d7497ab6f3f..326c6cd4ab2 100644
--- a/doc/lispref/symbols.texi
+++ b/doc/lispref/symbols.texi
@@ -487,6 +487,12 @@ using @code{eq}, so any object is a legitimate property.
487See @code{put} for an example. 487See @code{put} for an example.
488@end defun 488@end defun
489 489
490@defun function-get symbol property
491This function is identical to @code{get}, except that if @var{symbol}
492is the name of a function alias, it looks in the property list of the
493symbol naming the actual function. @xref{Defining Functions}.
494@end defun
495
490@defun put symbol property value 496@defun put symbol property value
491This function puts @var{value} onto @var{symbol}'s property list under 497This function puts @var{value} onto @var{symbol}'s property list under
492the property name @var{property}, replacing any previous property value. 498the property name @var{property}, replacing any previous property value.
diff --git a/etc/NEWS b/etc/NEWS
index 2166e1d7658..a6d6b1c5eeb 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -898,12 +898,15 @@ result in a warning ("Eager macro-expansion skipped due to cycle")
898describing the cycle. 898describing the cycle.
899 899
900** Miscellaneous new functions: 900** Miscellaneous new functions:
901 901+++
902*** `autoloadp' 902*** `autoloadp'
903+++
903*** `autoload-do-load' 904*** `autoload-do-load'
904+++ 905+++
905*** `buffer-narrowed-p' tests if the buffer is narrowed. 906*** `buffer-narrowed-p' tests if the buffer is narrowed.
907+++
906*** `file-name-base' returns a file name sans directory and extension. 908*** `file-name-base' returns a file name sans directory and extension.
909+++
907*** `function-get' fetches a function property, following aliases. 910*** `function-get' fetches a function property, following aliases.
908+++ 911+++
909*** `posnp' tests if an object is a `posn'. 912*** `posnp' tests if an object is a `posn'.
@@ -912,6 +915,7 @@ describing the cycle.
912*** `system-users' returns the user names on the system. 915*** `system-users' returns the user names on the system.
913+++ 916+++
914*** `system-groups' returns the group names on the system. 917*** `system-groups' returns the group names on the system.
918+++
915*** `tty-top-frame' returns the topmost frame of a text terminal. 919*** `tty-top-frame' returns the topmost frame of a text terminal.
916 920
917** New macros `setq-local' and `defvar-local'. 921** New macros `setq-local' and `defvar-local'.