diff options
| author | Eli Zaretskii | 2018-06-16 13:10:52 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2018-06-16 13:10:52 +0300 |
| commit | 0a6a2fb1d0b02a5ac442cf6b344e35696aac7eb7 (patch) | |
| tree | b388527691ad118a3dfbfda1937f6115c02eb8ec /doc | |
| parent | 2461266be1ea68a8c79af61abe850bb5a2c65040 (diff) | |
| download | emacs-0a6a2fb1d0b02a5ac442cf6b344e35696aac7eb7.tar.gz emacs-0a6a2fb1d0b02a5ac442cf6b344e35696aac7eb7.zip | |
Improve documentation of several recent changes
* src/xfaces.c (merge_face_ref): Fix a typo in the commentary.
(evaluate_face_filter, filter_face_ref): Minor copyedits in
the commentary.
* doc/lispref/display.texi (Face Remapping):
* doc/lispref/text.texi (Special Properties): Document the
':filter' face specs and their effects. Document
'face-filters-always-match'.
* doc/emacs/files.texi (Visiting): Document the new
possibility to visit large files literally in response to
question asked by Emacs.
* etc/NEWS: Mention the new possibility to visit large files
literally.
* lisp/files.el (files--ask-user-about-large-file): Use
"literally" instead of "raw", for consistency with
find-file-literally.
* doc/lispref/frames.texi (Input Focus): Tell explicitly that
focus-change events are sometimes supported on TTY frames.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/files.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 17 |
4 files changed, 34 insertions, 4 deletions
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index 7043bdc0688..f902baee9c2 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi | |||
| @@ -206,7 +206,10 @@ saved it. If the file has changed, Emacs offers to reread it. | |||
| 206 | If you try to visit a file larger than | 206 | If you try to visit a file larger than |
| 207 | @code{large-file-warning-threshold} (the default is 10000000, which is | 207 | @code{large-file-warning-threshold} (the default is 10000000, which is |
| 208 | about 10 megabytes), Emacs asks you for confirmation first. You can | 208 | about 10 megabytes), Emacs asks you for confirmation first. You can |
| 209 | answer @kbd{y} to proceed with visiting the file. Note, however, that | 209 | answer @kbd{y} to proceed with visiting the file or @kbd{l} to visit |
| 210 | the file literally (see below). Visiting large files literally speeds | ||
| 211 | up navigation and editing of such files, because various | ||
| 212 | potentially-expensive features are turned off. Note, however, that | ||
| 210 | Emacs cannot visit files that are larger than the maximum Emacs buffer | 213 | Emacs cannot visit files that are larger than the maximum Emacs buffer |
| 211 | size, which is limited by the amount of memory Emacs can allocate and | 214 | size, which is limited by the amount of memory Emacs can allocate and |
| 212 | by the integers that Emacs can represent (@pxref{Buffers}). If you | 215 | by the integers that Emacs can represent (@pxref{Buffers}). If you |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index ce7ec3ac10d..0ba7f0fd586 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -2938,7 +2938,13 @@ the remapped face---it replaces the normal definition of @var{face}, | |||
| 2938 | instead of modifying it. | 2938 | instead of modifying it. |
| 2939 | 2939 | ||
| 2940 | If @code{face-remapping-alist} is buffer-local, its local value takes | 2940 | If @code{face-remapping-alist} is buffer-local, its local value takes |
| 2941 | effect only within that buffer. | 2941 | effect only within that buffer. If @code{face-remapping-alist} |
| 2942 | includes faces applicable only to certain windows, by using the | ||
| 2943 | @w{@code{(:filtered (:window @var{param} @var{val}) @var{spec})}}, | ||
| 2944 | that face takes effect only in windows that match the filter | ||
| 2945 | conditions (@pxref{Special Properties}). To turn off face filtering | ||
| 2946 | temporarily, bind @code{face-filters-always-match} to a non-@code{nil} | ||
| 2947 | value, then all face filters will match any window. | ||
| 2942 | 2948 | ||
| 2943 | Note: face remapping is non-recursive. If @var{remapping} references | 2949 | Note: face remapping is non-recursive. If @var{remapping} references |
| 2944 | the same face name @var{face}, either directly or via the | 2950 | the same face name @var{face}, either directly or via the |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 5e8b5b46d5d..6678644bec7 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -2783,11 +2783,15 @@ could switch to a different terminal without switching back when | |||
| 2783 | you're done. | 2783 | you're done. |
| 2784 | @end deffn | 2784 | @end deffn |
| 2785 | 2785 | ||
| 2786 | @cindex text-terminal focus notification | ||
| 2786 | Emacs cooperates with the window system by arranging to select frames | 2787 | Emacs cooperates with the window system by arranging to select frames |
| 2787 | as the server and window manager request. When a window system | 2788 | as the server and window manager request. When a window system |
| 2788 | informs Emacs that one of its frames has been selected, Emacs | 2789 | informs Emacs that one of its frames has been selected, Emacs |
| 2789 | internally generates a @dfn{focus-in} event. Focus events are | 2790 | internally generates a @dfn{focus-in} event. When an Emacs frame is |
| 2790 | normally handled by @code{handle-focus-in}. | 2791 | displayed on a text-terminal emulator, such as @command{xterm}, which |
| 2792 | supports reporting of focus-change notification, the focus-in and | ||
| 2793 | focus-out events are available even for text-mode frames. Focus | ||
| 2794 | events are normally handled by @code{handle-focus-in}. | ||
| 2791 | 2795 | ||
| 2792 | @deffn Command handle-focus-in event | 2796 | @deffn Command handle-focus-in event |
| 2793 | This function handles focus-in events from window systems and | 2797 | This function handles focus-in events from window systems and |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index bb6ab04a927..ea9c82422ec 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3325,6 +3325,17 @@ foreground or background color, similar to @code{(:foreground | |||
| 3325 | @var{color-name})} or @code{(:background @var{color-name})}. This | 3325 | @var{color-name})} or @code{(:background @var{color-name})}. This |
| 3326 | form is supported for backward compatibility only, and should be | 3326 | form is supported for backward compatibility only, and should be |
| 3327 | avoided. | 3327 | avoided. |
| 3328 | |||
| 3329 | @item | ||
| 3330 | A cons cell of the form @w{@code{(:filtered @var{filter} | ||
| 3331 | @var{face-spec})}}, that specifies the face given by @var{face-spec}, | ||
| 3332 | but only if @var{filter} matches when the face is used for display. | ||
| 3333 | The @var{face-spec} can use any of the forms mentioned above. The | ||
| 3334 | @var{filter} should be of the form @w{@code{(:window @var{param} | ||
| 3335 | @var{value})}}, which matches for windows whose parameter @var{param} | ||
| 3336 | is @code{eq} to @var{value}. If the variable | ||
| 3337 | @code{face-filters-always-match} is non-@code{nil}, all face filters | ||
| 3338 | are deemed to have matched. | ||
| 3328 | @end itemize | 3339 | @end itemize |
| 3329 | 3340 | ||
| 3330 | Font Lock mode (@pxref{Font Lock Mode}) works in most buffers by | 3341 | Font Lock mode (@pxref{Font Lock Mode}) works in most buffers by |
| @@ -3699,6 +3710,12 @@ string to display, which is passed through | |||
| 3699 | The GNU Emacs Manual}) provides an example. | 3710 | The GNU Emacs Manual}) provides an example. |
| 3700 | @end defvar | 3711 | @end defvar |
| 3701 | 3712 | ||
| 3713 | @defvar face-filters-always-match | ||
| 3714 | If this variable is non-@code{nil}, face filters that specify | ||
| 3715 | attributes applied only when certain conditions are met will be deemed | ||
| 3716 | to match always. | ||
| 3717 | @end defvar | ||
| 3718 | |||
| 3702 | @node Format Properties | 3719 | @node Format Properties |
| 3703 | @subsection Formatted Text Properties | 3720 | @subsection Formatted Text Properties |
| 3704 | 3721 | ||