diff options
| author | Chong Yidong | 2012-10-30 08:29:37 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-10-30 08:29:37 +0800 |
| commit | e29e39c9c6aee68a50fef5149cc3acdfa74fec72 (patch) | |
| tree | c88836ed25faf44771754698c5508fcffb2b96d7 | |
| parent | fc83c2de544c15ce8e4e8fc7c6dd68cc4956a457 (diff) | |
| download | emacs-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/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 23 | ||||
| -rw-r--r-- | doc/lispref/loading.texi | 38 | ||||
| -rw-r--r-- | doc/lispref/symbols.texi | 6 | ||||
| -rw-r--r-- | etc/NEWS | 6 |
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 @@ | |||
| 1 | 2012-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 | |||
| 1 | 2012-10-28 Stefan Monnier <monnier@iro.umontreal.ca> | 9 | 2012-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 | |||
| 1493 | value is @code{t} if @var{frame} is visible, @code{nil} if it is | 1493 | value is @code{t} if @var{frame} is visible, @code{nil} if it is |
| 1494 | invisible, and @code{icon} if it is iconified. | 1494 | invisible, and @code{icon} if it is iconified. |
| 1495 | 1495 | ||
| 1496 | On a text terminal, all frames are considered visible, whether they | 1496 | On a text terminal, all frames are considered ``visible'' for the |
| 1497 | are currently being displayed or not. | 1497 | purposes 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 | |||
| 1550 | that the minibuffer window is in. | 1551 | that the minibuffer window is in. |
| 1551 | @end defopt | 1552 | @end defopt |
| 1552 | 1553 | ||
| 1553 | You can also enable auto-raise (raising automatically when a frame is | 1554 | On window systems, you can also enable auto-raising (on frame |
| 1554 | selected) or auto-lower (lowering automatically when it is deselected) | 1555 | selection) or auto-lowering (on frame deselection) using frame |
| 1555 | for any frame using frame parameters. @xref{Management Parameters}. | 1556 | parameters. @xref{Management Parameters}. |
| 1557 | |||
| 1558 | @cindex top frame | ||
| 1559 | The concept of raising and lowering frames also applies to text | ||
| 1560 | terminal frames. On each text terminal, only the top frame is | ||
| 1561 | displayed at any one time. | ||
| 1562 | |||
| 1563 | @defun tty-top-frame terminal | ||
| 1564 | This function returns the top frame on @var{terminal}. @var{terminal} | ||
| 1565 | should be a terminal object, a frame (meaning that frame's terminal), | ||
| 1566 | or @code{nil} (meaning the selected frame's terminal). If it does not | ||
| 1567 | refer 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} | |||
| 408 | specifies the file to load to get the real definition of @var{function}. | 408 | specifies the file to load to get the real definition of @var{function}. |
| 409 | 409 | ||
| 410 | If @var{filename} does not contain either a directory name, or the | 410 | If @var{filename} does not contain either a directory name, or the |
| 411 | suffix @code{.el} or @code{.elc}, then @code{autoload} insists on adding | 411 | suffix @code{.el} or @code{.elc}, this function insists on adding one |
| 412 | one of these suffixes, and it will not load from a file whose name is | 412 | of these suffixes, and it will not load from a file whose name is just |
| 413 | just @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 | ||
| 416 | The argument @var{docstring} is the documentation string for the | 416 | The 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 | |||
| 442 | symbol @var{function}. | 442 | symbol @var{function}. |
| 443 | 443 | ||
| 444 | @cindex function cell in autoload | 444 | @cindex function cell in autoload |
| 445 | If @var{function} already has a non-void function definition that is not | 445 | if @var{function} already has non-void function definition that is not |
| 446 | an autoload object, @code{autoload} does nothing and returns @code{nil}. | 446 | an autoload object, this function does nothing and returns @code{nil}. |
| 447 | If the function cell of @var{function} is void, or is already an autoload | 447 | Otherwise, it constructs an autoload object (@pxref{Autoload Type}), |
| 448 | object, then it is defined as an autoload object like this: | 448 | and stores it as the function definition for @var{function}. The |
| 449 | autoload 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 | |||
| 468 | not a macro or a keymap. | 469 | not a macro or a keymap. |
| 469 | @end defun | 470 | @end defun |
| 470 | 471 | ||
| 472 | @defun autoloadp object | ||
| 473 | This function returns non-@code{nil} if @var{object} is an autoload | ||
| 474 | object. For example, to check if @code{run-prolog} is defined as an | ||
| 475 | autoloaded 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 |
| 473 | or provide one or more features. If the file is not completely loaded | 484 | or 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 | |||
| 599 | assumed to contain a trailer starting with a formfeed character. | 610 | assumed 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 | ||
| 614 | specified by an autoload object: | ||
| 615 | |||
| 616 | @defun autoload-do-load autoload &optional name macro-only | ||
| 617 | This function performs the loading specified by @var{autoload}, which | ||
| 618 | whould be an autoload object. The optional argument @var{name}, if | ||
| 619 | non-@code{nil}, should be a symbol whose function value is | ||
| 620 | @var{autoload}; in that case, the return value of this function is the | ||
| 621 | symbol's new function value. If the value of the optional argument | ||
| 622 | @var{macro-only} is @code{macro}, this function avoids loading a | ||
| 623 | function, 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. | |||
| 487 | See @code{put} for an example. | 487 | See @code{put} for an example. |
| 488 | @end defun | 488 | @end defun |
| 489 | 489 | ||
| 490 | @defun function-get symbol property | ||
| 491 | This function is identical to @code{get}, except that if @var{symbol} | ||
| 492 | is the name of a function alias, it looks in the property list of the | ||
| 493 | symbol naming the actual function. @xref{Defining Functions}. | ||
| 494 | @end defun | ||
| 495 | |||
| 490 | @defun put symbol property value | 496 | @defun put symbol property value |
| 491 | This function puts @var{value} onto @var{symbol}'s property list under | 497 | This function puts @var{value} onto @var{symbol}'s property list under |
| 492 | the property name @var{property}, replacing any previous property value. | 498 | the property name @var{property}, replacing any previous property value. |
| @@ -898,12 +898,15 @@ result in a warning ("Eager macro-expansion skipped due to cycle") | |||
| 898 | describing the cycle. | 898 | describing 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'. |