diff options
| author | Miles Bader | 2007-12-06 00:46:18 +0000 |
|---|---|---|
| committer | Miles Bader | 2007-12-06 00:46:18 +0000 |
| commit | e5e76c04310d287a56675876dd83e1089faba215 (patch) | |
| tree | a4b4f1cc134e4fd5af42671ec6689e07afe48ff2 /doc | |
| parent | b890d447fb56bfe9f2e4742eda4b3ab4b5f4b32a (diff) | |
| parent | a2afc99dbad3fa9a3170ad72c578451c3aea58a4 (diff) | |
| download | emacs-e5e76c04310d287a56675876dd83e1089faba215.tar.gz emacs-e5e76c04310d287a56675876dd83e1089faba215.zip | |
Merge from emacs--rel--22
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-943
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 17 | ||||
| -rw-r--r-- | doc/lispref/customize.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 80 | ||||
| -rw-r--r-- | doc/lispref/hooks.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/objects.texi | 2 |
5 files changed, 76 insertions, 32 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 95ab2e09b4b..586f250bd06 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2007-12-04 Richard Stallman <rms@gnu.org> | ||
| 2 | |||
| 3 | * objects.texi (Symbol Type): Fix typo. | ||
| 4 | |||
| 5 | 2007-12-03 Richard Stallman <rms@gnu.org> | ||
| 6 | |||
| 7 | * hooks.texi (Standard Hooks): Add link to Hooks for Loading. | ||
| 8 | |||
| 1 | 2007-12-01 Glenn Morris <rgm@gnu.org> | 9 | 2007-12-01 Glenn Morris <rgm@gnu.org> |
| 2 | 10 | ||
| 3 | * functions.texi (Declaring Functions): Improve previous change. | 11 | * functions.texi (Declaring Functions): Improve previous change. |
| @@ -7,6 +15,10 @@ | |||
| 7 | * functions.texi (Declaring Functions): Add optional fourth | 15 | * functions.texi (Declaring Functions): Add optional fourth |
| 8 | argument of declare-function, and setting third argument to `t'. | 16 | argument of declare-function, and setting third argument to `t'. |
| 9 | 17 | ||
| 18 | 2007-11-29 Richard Stallman <rms@gnu.org> | ||
| 19 | |||
| 20 | * customize.texi (Composite Types): Document `group' type. | ||
| 21 | |||
| 10 | 2007-11-29 Glenn Morris <rgm@gnu.org> | 22 | 2007-11-29 Glenn Morris <rgm@gnu.org> |
| 11 | 23 | ||
| 12 | * functions.texi (Declaring Functions): Add findex. Mention | 24 | * functions.texi (Declaring Functions): Add findex. Mention |
| @@ -34,6 +46,11 @@ | |||
| 34 | 46 | ||
| 35 | * compile.texi (Compiler Errors): Clarify previous change. | 47 | * compile.texi (Compiler Errors): Clarify previous change. |
| 36 | 48 | ||
| 49 | 2007-11-24 Richard Stallman <rms@gnu.org> | ||
| 50 | |||
| 51 | * display.texi (Refresh Screen, Forcing Redisplay): | ||
| 52 | Clarify the text and move items around. | ||
| 53 | |||
| 37 | 2007-11-24 Glenn Morris <rgm@gnu.org> | 54 | 2007-11-24 Glenn Morris <rgm@gnu.org> |
| 38 | 55 | ||
| 39 | * functions.texi (Declaring Functions): New section. | 56 | * functions.texi (Declaring Functions): New section. |
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 7c723a29f28..b97ce20fc22 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi | |||
| @@ -755,6 +755,11 @@ string, and the third a function. | |||
| 755 | In the customization buffer, each element is displayed and edited | 755 | In the customization buffer, each element is displayed and edited |
| 756 | separately, according to the type specified for it. | 756 | separately, according to the type specified for it. |
| 757 | 757 | ||
| 758 | @item (group @var{element-types}@dots{}) | ||
| 759 | This works like @code{list} except for the formatting | ||
| 760 | of text in the Custom buffer. @code{list} labels each | ||
| 761 | element value with its tag; @code{group} does not. | ||
| 762 | |||
| 758 | @item (vector @var{element-types}@dots{}) | 763 | @item (vector @var{element-types}@dots{}) |
| 759 | Like @code{list} except that the value must be a vector instead of a | 764 | Like @code{list} except that the value must be a vector instead of a |
| 760 | list. The elements work the same as in @code{list}. | 765 | list. The elements work the same as in @code{list}. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 4c9df9c5ede..165636006d3 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -55,21 +55,10 @@ This function clears and redisplays frame @var{frame}. | |||
| 55 | This function clears and redisplays all visible frames. | 55 | This function clears and redisplays all visible frames. |
| 56 | @end deffn | 56 | @end deffn |
| 57 | 57 | ||
| 58 | This function calls for redisplay of certain windows, the next time | 58 | In Emacs, processing user input takes priority over redisplay. If |
| 59 | redisplay is done, but does not clear them first. | 59 | you call these functions when input is available, they don't redisplay |
| 60 | 60 | immediately, but the requested redisplay does happen | |
| 61 | @defun force-window-update &optional object | 61 | eventually---after all the input has been processed. |
| 62 | This function forces some or all windows to be updated on next redisplay. | ||
| 63 | If @var{object} is a window, it forces redisplay of that window. If | ||
| 64 | @var{object} is a buffer or buffer name, it forces redisplay of all | ||
| 65 | windows displaying that buffer. If @var{object} is @code{nil} (or | ||
| 66 | omitted), it forces redisplay of all windows. | ||
| 67 | @end defun | ||
| 68 | |||
| 69 | Processing user input takes absolute priority over redisplay. If you | ||
| 70 | call these functions when input is available, they do nothing | ||
| 71 | immediately, but a full redisplay does happen eventually---after all the | ||
| 72 | input has been processed. | ||
| 73 | 62 | ||
| 74 | Normally, suspending and resuming Emacs also refreshes the screen. | 63 | Normally, suspending and resuming Emacs also refreshes the screen. |
| 75 | Some terminal emulators record separate contents for display-oriented | 64 | Some terminal emulators record separate contents for display-oriented |
| @@ -89,11 +78,56 @@ to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. | |||
| 89 | @section Forcing Redisplay | 78 | @section Forcing Redisplay |
| 90 | @cindex forcing redisplay | 79 | @cindex forcing redisplay |
| 91 | 80 | ||
| 81 | Emacs normally tries to redisplay the screen whenever it waits for | ||
| 82 | input. With this function you can request an immediate attempt to | ||
| 83 | redisplay, in the middle of Lisp code, without actually waiting for | ||
| 84 | input. | ||
| 85 | |||
| 86 | @defun redisplay &optional force | ||
| 87 | This function tries immediately to redisplay, provided there are no | ||
| 88 | pending input events. It is equivalent to @code{(sit-for 0)}. | ||
| 89 | |||
| 90 | If the optional argument @var{force} is non-@code{nil}, it does all | ||
| 91 | pending redisplay work even if input is available, with no | ||
| 92 | pre-emption. | ||
| 93 | |||
| 94 | The function returns @code{t} if it actually tried to redisplay, and | ||
| 95 | @code{nil} otherwise. A value of @code{t} does not mean that | ||
| 96 | redisplay proceeded to completion; it could have been pre-empted by | ||
| 97 | newly arriving terminal input. | ||
| 98 | @end defun | ||
| 99 | |||
| 100 | @code{redisplay} with no argument tries immediately to redisplay, | ||
| 101 | but has no effect on the usual rules for what parts of the screen to | ||
| 102 | redisplay. By contrast, the following function adds certain windows | ||
| 103 | to the pending redisplay work (as if their contents had completely | ||
| 104 | changed), but doesn't immediately try to do any redisplay work. | ||
| 105 | |||
| 106 | @defun force-window-update &optional object | ||
| 107 | This function forces some or all windows to be updated on next | ||
| 108 | redisplay. If @var{object} is a window, it requires eventual | ||
| 109 | redisplay of that window. If @var{object} is a buffer or buffer name, | ||
| 110 | it requires eventual redisplay of all windows displaying that buffer. | ||
| 111 | If @var{object} is @code{nil} (or omitted), it requires eventual | ||
| 112 | redisplay of all windows. | ||
| 113 | @end defun | ||
| 114 | |||
| 115 | @code{force-window-update} does not do a redisplay immediately. | ||
| 116 | (Emacs will do that when it waits for input.) Rather, its effect is | ||
| 117 | to put more work on the queue to be done by redisplay whenever there | ||
| 118 | is a chance. | ||
| 119 | |||
| 92 | Emacs redisplay normally stops if input arrives, and does not happen | 120 | Emacs redisplay normally stops if input arrives, and does not happen |
| 93 | at all if input is available before it starts. Most of the time, this | 121 | at all if input is available before it starts. Most of the time, this |
| 94 | is exactly what you want. However, you can prevent preemption by | 122 | is exactly what you want. However, you can prevent preemption by |
| 95 | binding @code{redisplay-dont-pause} to a non-@code{nil} value. | 123 | binding @code{redisplay-dont-pause} to a non-@code{nil} value. |
| 96 | 124 | ||
| 125 | @defvar redisplay-dont-pause | ||
| 126 | If this variable is non-@code{nil}, pending input does not | ||
| 127 | prevent or halt redisplay; redisplay occurs, and finishes, | ||
| 128 | regardless of whether input is available. | ||
| 129 | @end defvar | ||
| 130 | |||
| 97 | @defvar redisplay-preemption-period | 131 | @defvar redisplay-preemption-period |
| 98 | This variable specifies how many seconds Emacs waits between checks | 132 | This variable specifies how many seconds Emacs waits between checks |
| 99 | for new input during redisplay. (The default is 0.1 seconds.) If | 133 | for new input during redisplay. (The default is 0.1 seconds.) If |
| @@ -107,22 +141,6 @@ This variable is only obeyed on graphical terminals. For | |||
| 107 | text terminals, see @ref{Terminal Output}. | 141 | text terminals, see @ref{Terminal Output}. |
| 108 | @end defvar | 142 | @end defvar |
| 109 | 143 | ||
| 110 | @defvar redisplay-dont-pause | ||
| 111 | If this variable is non-@code{nil}, pending input does not | ||
| 112 | prevent or halt redisplay; redisplay occurs, and finishes, | ||
| 113 | regardless of whether input is available. | ||
| 114 | @end defvar | ||
| 115 | |||
| 116 | @defun redisplay &optional force | ||
| 117 | This function performs an immediate redisplay provided there are no | ||
| 118 | pending input events. This is equivalent to @code{(sit-for 0)}. | ||
| 119 | |||
| 120 | If the optional argument @var{force} is non-@code{nil}, it forces an | ||
| 121 | immediate and complete redisplay even if input is available. | ||
| 122 | |||
| 123 | Returns @code{t} if redisplay was performed, or @code{nil} otherwise. | ||
| 124 | @end defun | ||
| 125 | |||
| 126 | @node Truncation | 144 | @node Truncation |
| 127 | @section Truncation | 145 | @section Truncation |
| 128 | @cindex line wrapping | 146 | @cindex line wrapping |
diff --git a/doc/lispref/hooks.texi b/doc/lispref/hooks.texi index d0bb2de8675..3f7f4b4d8bb 100644 --- a/doc/lispref/hooks.texi +++ b/doc/lispref/hooks.texi | |||
| @@ -31,6 +31,10 @@ these functions are called in a special way (they are passed arguments, | |||
| 31 | or their values are used). The variables whose names end in | 31 | or their values are used). The variables whose names end in |
| 32 | @samp{-function} have single functions as their values. | 32 | @samp{-function} have single functions as their values. |
| 33 | 33 | ||
| 34 | A special feature allows you to specify expressions to evaluate if and | ||
| 35 | when a file is loaded (@pxref{Hooks for Loading}). That feature is | ||
| 36 | not exactly a hook, but does a similar job. | ||
| 37 | |||
| 34 | @c We need to xref to where each hook is documented or else document | 38 | @c We need to xref to where each hook is documented or else document |
| 35 | @c it here. | 39 | @c it here. |
| 36 | 40 | ||
diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi index 0da05488858..64c79d63162 100644 --- a/doc/lispref/objects.texi +++ b/doc/lispref/objects.texi | |||
| @@ -525,7 +525,7 @@ bit values are 2**22 for alt, 2**23 for super and 2**24 for hyper. | |||
| 525 | 525 | ||
| 526 | A @dfn{symbol} in GNU Emacs Lisp is an object with a name. The | 526 | A @dfn{symbol} in GNU Emacs Lisp is an object with a name. The |
| 527 | symbol name serves as the printed representation of the symbol. In | 527 | symbol name serves as the printed representation of the symbol. In |
| 528 | ordinary Lisp use, with one single obarray (@pxref{Creating Symbols}, | 528 | ordinary Lisp use, with one single obarray (@pxref{Creating Symbols}), |
| 529 | a symbol's name is unique---no two symbols have the same name. | 529 | a symbol's name is unique---no two symbols have the same name. |
| 530 | 530 | ||
| 531 | A symbol can serve as a variable, as a function name, or to hold a | 531 | A symbol can serve as a variable, as a function name, or to hold a |