diff options
| author | Chong Yidong | 2005-09-08 22:00:58 +0000 |
|---|---|---|
| committer | Chong Yidong | 2005-09-08 22:00:58 +0000 |
| commit | 475aab0deb5eb47377335137afd190ece9fcd92c (patch) | |
| tree | 54726842f6e88b23e989787355a917a6d66e4553 | |
| parent | 9815ca3d25923c59711abf757c6371bc3548b318 (diff) | |
| download | emacs-475aab0deb5eb47377335137afd190ece9fcd92c.tar.gz emacs-475aab0deb5eb47377335137afd190ece9fcd92c.zip | |
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
* locals.texi (Standard Buffer-Local Variables): Don't include
mode variables for minor modes.
Fix xrefs for buffer-display-count, buffer-display-table,
buffer-offer-save, buffer-saved-size, cache-long-line-scans,
enable-multibyte-characters, fill-column, header-line-format,
left-fringe-width, left-margin, and right-fringe-width.
* hooks.texi (Standard Hooks): All hooks should conform to the
standard naming convention now.
Fix xref for `echo-area-clear-hook'.
* display.texi (Usual Display): Note that indicate-empty-lines and
tab-width are buffer-local.
* files.texi (Saving Buffers): Add xref to `Killing Buffers'.
* modes.texi (Mode Help): Note that major-mode is buffer-local.
* nonascii.texi (Encoding and I/O): Note that
buffer-file-coding-system is buffer-local.
* positions.texi (List Motion): Note that defun-prompt-regexp is
buffer-local.
* text.texi (Auto Filling): Note that auto-fill-function is
buffer-local.
(Undo): Note that buffer-undo-list is buffer-local.
* windows.texi (Buffers and Windows): Document
buffer-display-count.
| -rw-r--r-- | lispref/ChangeLog | 33 | ||||
| -rw-r--r-- | lispref/display.texi | 11 | ||||
| -rw-r--r-- | lispref/files.texi | 8 | ||||
| -rw-r--r-- | lispref/hooks.texi | 15 | ||||
| -rw-r--r-- | lispref/locals.texi | 39 | ||||
| -rw-r--r-- | lispref/modes.texi | 10 | ||||
| -rw-r--r-- | lispref/nonascii.texi | 4 | ||||
| -rw-r--r-- | lispref/positions.texi | 10 | ||||
| -rw-r--r-- | lispref/text.texi | 8 | ||||
| -rw-r--r-- | lispref/windows.texi | 6 |
10 files changed, 89 insertions, 55 deletions
diff --git a/lispref/ChangeLog b/lispref/ChangeLog index 8fc5754bf80..a16d3c9d6d5 100644 --- a/lispref/ChangeLog +++ b/lispref/ChangeLog | |||
| @@ -1,3 +1,36 @@ | |||
| 1 | 2005-09-08 Chong Yidong <cyd@stupidchicken.com> | ||
| 2 | |||
| 3 | * locals.texi (Standard Buffer-Local Variables): Don't include | ||
| 4 | mode variables for minor modes. | ||
| 5 | Fix xrefs for buffer-display-count, buffer-display-table, | ||
| 6 | buffer-offer-save, buffer-saved-size, cache-long-line-scans, | ||
| 7 | enable-multibyte-characters, fill-column, header-line-format, | ||
| 8 | left-fringe-width, left-margin, and right-fringe-width. | ||
| 9 | |||
| 10 | * hooks.texi (Standard Hooks): All hooks should conform to the | ||
| 11 | standard naming convention now. | ||
| 12 | Fix xref for `echo-area-clear-hook'. | ||
| 13 | |||
| 14 | * display.texi (Usual Display): Note that indicate-empty-lines and | ||
| 15 | tab-width are buffer-local. | ||
| 16 | |||
| 17 | * files.texi (Saving Buffers): Add xref to `Killing Buffers'. | ||
| 18 | |||
| 19 | * modes.texi (Mode Help): Note that major-mode is buffer-local. | ||
| 20 | |||
| 21 | * nonascii.texi (Encoding and I/O): Note that | ||
| 22 | buffer-file-coding-system is buffer-local. | ||
| 23 | |||
| 24 | * positions.texi (List Motion): Note that defun-prompt-regexp is | ||
| 25 | buffer-local. | ||
| 26 | |||
| 27 | * text.texi (Auto Filling): Note that auto-fill-function is | ||
| 28 | buffer-local. | ||
| 29 | (Undo): Note that buffer-undo-list is buffer-local. | ||
| 30 | |||
| 31 | * windows.texi (Buffers and Windows): Document | ||
| 32 | buffer-display-count. | ||
| 33 | |||
| 1 | 2005-09-06 Richard M. Stallman <rms@gnu.org> | 34 | 2005-09-06 Richard M. Stallman <rms@gnu.org> |
| 2 | 35 | ||
| 3 | * tips.texi (Coding Conventions): Sometimes it is ok to put the | 36 | * tips.texi (Coding Conventions): Sometimes it is ok to put the |
diff --git a/lispref/display.texi b/lispref/display.texi index 8addb3b67ec..b6348800fad 100644 --- a/lispref/display.texi +++ b/lispref/display.texi | |||
| @@ -4546,11 +4546,11 @@ buffers that do not override it. @xref{Default Value}. | |||
| 4546 | @end defvar | 4546 | @end defvar |
| 4547 | 4547 | ||
| 4548 | @defopt tab-width | 4548 | @defopt tab-width |
| 4549 | The value of this variable is the spacing between tab stops used for | 4549 | The value of this buffer-local variable is the spacing between tab |
| 4550 | displaying tab characters in Emacs buffers. The value is in units of | 4550 | stops used for displaying tab characters in Emacs buffers. The value |
| 4551 | columns, and the default is 8. Note that this feature is completely | 4551 | is in units of columns, and the default is 8. Note that this feature |
| 4552 | independent of the user-settable tab stops used by the command | 4552 | is completely independent of the user-settable tab stops used by the |
| 4553 | @code{tab-to-tab-stop}. @xref{Indent Tabs}. | 4553 | command @code{tab-to-tab-stop}. @xref{Indent Tabs}. |
| 4554 | @end defopt | 4554 | @end defopt |
| 4555 | 4555 | ||
| 4556 | @defopt indicate-empty-lines | 4556 | @defopt indicate-empty-lines |
| @@ -4559,6 +4559,7 @@ independent of the user-settable tab stops used by the command | |||
| 4559 | When this is non-@code{nil}, Emacs displays a special glyph in the | 4559 | When this is non-@code{nil}, Emacs displays a special glyph in the |
| 4560 | fringe of each empty line at the end of the buffer, on terminals that | 4560 | fringe of each empty line at the end of the buffer, on terminals that |
| 4561 | support it (window systems). @xref{Fringes}. | 4561 | support it (window systems). @xref{Fringes}. |
| 4562 | This variable is automatically buffer-local in every buffer. | ||
| 4562 | @end defopt | 4563 | @end defopt |
| 4563 | 4564 | ||
| 4564 | @defvar indicate-buffer-boundaries | 4565 | @defvar indicate-buffer-boundaries |
diff --git a/lispref/files.texi b/lispref/files.texi index 1ec4b2e5dc2..570b601f743 100644 --- a/lispref/files.texi +++ b/lispref/files.texi | |||
| @@ -341,10 +341,10 @@ The optional @var{pred} argument controls which buffers to ask about | |||
| 341 | If it is @code{nil}, that means to ask only about file-visiting buffers. | 341 | If it is @code{nil}, that means to ask only about file-visiting buffers. |
| 342 | If it is @code{t}, that means also offer to save certain other non-file | 342 | If it is @code{t}, that means also offer to save certain other non-file |
| 343 | buffers---those that have a non-@code{nil} buffer-local value of | 343 | buffers---those that have a non-@code{nil} buffer-local value of |
| 344 | @code{buffer-offer-save}. (A user who says @samp{yes} to saving a | 344 | @code{buffer-offer-save} (@pxref{Killing Buffers}). A user who says |
| 345 | non-file buffer is asked to specify the file name to use.) The | 345 | @samp{yes} to saving a non-file buffer is asked to specify the file |
| 346 | @code{save-buffers-kill-emacs} function passes the value @code{t} for | 346 | name to use.) The @code{save-buffers-kill-emacs} function passes the |
| 347 | @var{pred}. | 347 | value @code{t} for @var{pred}. |
| 348 | 348 | ||
| 349 | If @var{pred} is neither @code{t} nor @code{nil}, then it should be | 349 | If @var{pred} is neither @code{t} nor @code{nil}, then it should be |
| 350 | a function of no arguments. It will be called in each buffer to decide | 350 | a function of no arguments. It will be called in each buffer to decide |
diff --git a/lispref/hooks.texi b/lispref/hooks.texi index 11b2233dc0e..795048fdb25 100644 --- a/lispref/hooks.texi +++ b/lispref/hooks.texi | |||
| @@ -26,14 +26,13 @@ are omitted in the list below. | |||
| 26 | The variables whose names end in @samp{-hooks} or @samp{-functions} are | 26 | The variables whose names end in @samp{-hooks} or @samp{-functions} are |
| 27 | usually @dfn{abnormal hooks}; their values are lists of functions, but | 27 | usually @dfn{abnormal hooks}; their values are lists of functions, but |
| 28 | these functions are called in a special way (they are passed arguments, | 28 | these functions are called in a special way (they are passed arguments, |
| 29 | or their values are used). A few of these variables are actually normal | 29 | or their values are used). The variables whose names end in |
| 30 | hooks which were named before we established the convention that normal | 30 | @samp{-function} have single functions as their values. |
| 31 | hooks' names should end in @samp{-hook}. | ||
| 32 | 31 | ||
| 33 | The variables whose names end in @samp{-function} have single functions | 32 | (In older Emacs versions, some normal hooks had names ending in |
| 34 | as their values. (In older Emacs versions, some of these variables had | 33 | @samp{-hooks} or @samp{-functions}, and some abnormal hooks had names |
| 35 | names ending in @samp{-hook} even though they were not normal hooks; | 34 | ending in @samp{-hook}. We have renamed all of these to conform to |
| 36 | however, we have renamed all of those.) | 35 | the above conventions.) |
| 37 | 36 | ||
| 38 | @c We need to xref to where each hook is documented or else document | 37 | @c We need to xref to where each hook is documented or else document |
| 39 | @c it here. | 38 | @c it here. |
| @@ -135,7 +134,7 @@ for appointment notification. | |||
| 135 | @xref{Disabling Commands}. | 134 | @xref{Disabling Commands}. |
| 136 | 135 | ||
| 137 | @item echo-area-clear-hook | 136 | @item echo-area-clear-hook |
| 138 | @xref{The Echo Area}. | 137 | @xref{Echo Area Customization}. |
| 139 | 138 | ||
| 140 | @item emacs-startup-hook | 139 | @item emacs-startup-hook |
| 141 | @xref{Init File}. | 140 | @xref{Init File}. |
diff --git a/lispref/locals.texi b/lispref/locals.texi index 57b17d3d41b..e24117270a5 100644 --- a/lispref/locals.texi +++ b/lispref/locals.texi | |||
| @@ -15,10 +15,11 @@ buffer-local only when set; a few of them are always local in every | |||
| 15 | buffer. Many Lisp packages define such variables for their internal | 15 | buffer. Many Lisp packages define such variables for their internal |
| 16 | use, but we don't try to list them all here. | 16 | use, but we don't try to list them all here. |
| 17 | 17 | ||
| 18 | @table @code | 18 | Each minor modes defines a buffer-local variable named |
| 19 | @item abbrev-mode | 19 | @samp{@var{modename}-mode}. @xref{Minor Mode Conventions}. Minor |
| 20 | @xref{Abbrevs}. | 20 | mode variables will not be listed here. |
| 21 | 21 | ||
| 22 | @table @code | ||
| 22 | @item auto-fill-function | 23 | @item auto-fill-function |
| 23 | @xref{Auto Filling}. | 24 | @xref{Auto Filling}. |
| 24 | 25 | ||
| @@ -29,13 +30,13 @@ use, but we don't try to list them all here. | |||
| 29 | @xref{Auto-Saving}. | 30 | @xref{Auto-Saving}. |
| 30 | 31 | ||
| 31 | @item buffer-backed-up | 32 | @item buffer-backed-up |
| 32 | @xref{Backup Files}. | 33 | @xref{Making Backups}. |
| 33 | 34 | ||
| 34 | @item buffer-display-count | 35 | @item buffer-display-count |
| 35 | @xref{Displaying Buffers}. | 36 | @xref{Buffers and Windows}. |
| 36 | 37 | ||
| 37 | @item buffer-display-table | 38 | @item buffer-display-table |
| 38 | @xref{Display Tables}. | 39 | @xref{Active Display Table}. |
| 39 | 40 | ||
| 40 | @item buffer-display-time | 41 | @item buffer-display-time |
| 41 | @xref{Buffers and Windows}. | 42 | @xref{Buffers and Windows}. |
| @@ -62,19 +63,19 @@ use, but we don't try to list them all here. | |||
| 62 | @xref{Invisible Text}. | 63 | @xref{Invisible Text}. |
| 63 | 64 | ||
| 64 | @item buffer-offer-save | 65 | @item buffer-offer-save |
| 65 | @xref{Saving Buffers}. | 66 | @xref{Killing Buffers}. |
| 66 | 67 | ||
| 67 | @item buffer-read-only | 68 | @item buffer-read-only |
| 68 | @xref{Read Only Buffers}. | 69 | @xref{Read Only Buffers}. |
| 69 | 70 | ||
| 70 | @item buffer-saved-size | 71 | @item buffer-saved-size |
| 71 | @xref{Point}. | 72 | @xref{Auto-Saving}. |
| 72 | 73 | ||
| 73 | @item buffer-undo-list | 74 | @item buffer-undo-list |
| 74 | @xref{Undo}. | 75 | @xref{Undo}. |
| 75 | 76 | ||
| 76 | @item cache-long-line-scans | 77 | @item cache-long-line-scans |
| 77 | @xref{Text Lines}. | 78 | @xref{Truncation}. |
| 78 | 79 | ||
| 79 | @item case-fold-search | 80 | @item case-fold-search |
| 80 | @xref{Searching and Case}. | 81 | @xref{Searching and Case}. |
| @@ -103,10 +104,10 @@ Does not work yet. | |||
| 103 | @end ignore | 104 | @end ignore |
| 104 | 105 | ||
| 105 | @item enable-multibyte-characters | 106 | @item enable-multibyte-characters |
| 106 | @ref{Non-ASCII Characters}. | 107 | @ref{Text Representations}. |
| 107 | 108 | ||
| 108 | @item fill-column | 109 | @item fill-column |
| 109 | @xref{Auto Filling}. | 110 | @xref{Margins}. |
| 110 | 111 | ||
| 111 | @item fringes-outside-margins | 112 | @item fringes-outside-margins |
| 112 | @xref{Fringes}. | 113 | @xref{Fringes}. |
| @@ -115,7 +116,7 @@ Does not work yet. | |||
| 115 | @xref{Moving Point,,, emacs, The GNU Emacs Manual}. | 116 | @xref{Moving Point,,, emacs, The GNU Emacs Manual}. |
| 116 | 117 | ||
| 117 | @item header-line-format | 118 | @item header-line-format |
| 118 | @xref{Mode Line Data}. | 119 | @xref{Header Lines}. |
| 119 | 120 | ||
| 120 | @item indicate-buffer-boundaries | 121 | @item indicate-buffer-boundaries |
| 121 | @xref{Usual Display}. | 122 | @xref{Usual Display}. |
| @@ -124,10 +125,10 @@ Does not work yet. | |||
| 124 | @xref{Usual Display}. | 125 | @xref{Usual Display}. |
| 125 | 126 | ||
| 126 | @item left-fringe-width | 127 | @item left-fringe-width |
| 127 | @xref{Fringes}. | 128 | @xref{Fringe Size/Pos}. |
| 128 | 129 | ||
| 129 | @item left-margin | 130 | @item left-margin |
| 130 | @xref{Indentation}. | 131 | @xref{Margins}. |
| 131 | 132 | ||
| 132 | @item left-margin-width | 133 | @item left-margin-width |
| 133 | @xref{Display Margins}. | 134 | @xref{Display Margins}. |
| @@ -136,7 +137,7 @@ Does not work yet. | |||
| 136 | @xref{Line Height}. | 137 | @xref{Line Height}. |
| 137 | 138 | ||
| 138 | @item local-abbrev-table | 139 | @item local-abbrev-table |
| 139 | @xref{Abbrevs}. | 140 | @xref{Standard Abbrev Tables}. |
| 140 | 141 | ||
| 141 | @item major-mode | 142 | @item major-mode |
| 142 | @xref{Mode Help}. | 143 | @xref{Mode Help}. |
| @@ -162,14 +163,11 @@ Does not work yet. | |||
| 162 | @item mode-name | 163 | @item mode-name |
| 163 | @xref{Mode Line Variables}. | 164 | @xref{Mode Line Variables}. |
| 164 | 165 | ||
| 165 | @item overwrite-mode | ||
| 166 | @xref{Insertion}. | ||
| 167 | |||
| 168 | @item point-before-scroll | 166 | @item point-before-scroll |
| 169 | Used for communication between mouse commands and scroll-bar commands. | 167 | Used for communication between mouse commands and scroll-bar commands. |
| 170 | 168 | ||
| 171 | @item right-fringe-width | 169 | @item right-fringe-width |
| 172 | @xref{Fringes}. | 170 | @xref{Fringe Size/Pos}. |
| 173 | 171 | ||
| 174 | @item right-margin-width | 172 | @item right-margin-width |
| 175 | @xref{Display Margins}. | 173 | @xref{Display Margins}. |
| @@ -195,9 +193,6 @@ Used for communication between mouse commands and scroll-bar commands. | |||
| 195 | @item truncate-lines | 193 | @item truncate-lines |
| 196 | @xref{Truncation}. | 194 | @xref{Truncation}. |
| 197 | 195 | ||
| 198 | @item vc-mode | ||
| 199 | @xref{Mode Line Variables}. | ||
| 200 | |||
| 201 | @item vertical-scroll-bar | 196 | @item vertical-scroll-bar |
| 202 | @xref{Scroll Bars}. | 197 | @xref{Scroll Bars}. |
| 203 | @end table | 198 | @end table |
diff --git a/lispref/modes.texi b/lispref/modes.texi index a391f27a80f..27aea507cc8 100644 --- a/lispref/modes.texi +++ b/lispref/modes.texi | |||
| @@ -961,11 +961,11 @@ displays the documentation string of the major mode function. | |||
| 961 | @end deffn | 961 | @end deffn |
| 962 | 962 | ||
| 963 | @defvar major-mode | 963 | @defvar major-mode |
| 964 | This variable holds the symbol for the current buffer's major mode. | 964 | This buffer-local variable holds the symbol for the current buffer's |
| 965 | This symbol should have a function definition that is the command to | 965 | major mode. This symbol should have a function definition that is the |
| 966 | switch to that major mode. The @code{describe-mode} function uses the | 966 | command to switch to that major mode. The @code{describe-mode} |
| 967 | documentation string of the function as the documentation of the major | 967 | function uses the documentation string of the function as the |
| 968 | mode. | 968 | documentation of the major mode. |
| 969 | @end defvar | 969 | @end defvar |
| 970 | 970 | ||
| 971 | @node Derived Modes | 971 | @node Derived Modes |
diff --git a/lispref/nonascii.texi b/lispref/nonascii.texi index 2af367a0f85..73632e36514 100644 --- a/lispref/nonascii.texi +++ b/lispref/nonascii.texi | |||
| @@ -717,8 +717,8 @@ operation finishes the job of choosing a coding system. Very often | |||
| 717 | you will want to find out afterwards which coding system was chosen. | 717 | you will want to find out afterwards which coding system was chosen. |
| 718 | 718 | ||
| 719 | @defvar buffer-file-coding-system | 719 | @defvar buffer-file-coding-system |
| 720 | This variable records the coding system that was used for visiting the | 720 | This buffer-local variable records the coding system that was used to visit |
| 721 | current buffer. It is used for saving the buffer, and for writing part | 721 | the current buffer. It is used for saving the buffer, and for writing part |
| 722 | of the buffer with @code{write-region}. If the text to be written | 722 | of the buffer with @code{write-region}. If the text to be written |
| 723 | cannot be safely encoded using the coding system specified by this | 723 | cannot be safely encoded using the coding system specified by this |
| 724 | variable, these operations select an alternative encoding by calling | 724 | variable, these operations select an alternative encoding by calling |
diff --git a/lispref/positions.texi b/lispref/positions.texi index cb249f526f1..77063addf9a 100644 --- a/lispref/positions.texi +++ b/lispref/positions.texi | |||
| @@ -720,11 +720,11 @@ to 1. | |||
| 720 | @end deffn | 720 | @end deffn |
| 721 | 721 | ||
| 722 | @defopt defun-prompt-regexp | 722 | @defopt defun-prompt-regexp |
| 723 | If non-@code{nil}, this variable holds a regular expression that | 723 | If non-@code{nil}, this buffer-local variable holds a regular |
| 724 | specifies what text can appear before the open-parenthesis that starts a | 724 | expression that specifies what text can appear before the |
| 725 | defun. That is to say, a defun begins on a line that starts with a | 725 | open-parenthesis that starts a defun. That is to say, a defun begins |
| 726 | match for this regular expression, followed by a character with | 726 | on a line that starts with a match for this regular expression, |
| 727 | open-parenthesis syntax. | 727 | followed by a character with open-parenthesis syntax. |
| 728 | @end defopt | 728 | @end defopt |
| 729 | 729 | ||
| 730 | @defopt open-paren-in-column-0-is-defun-start | 730 | @defopt open-paren-in-column-0-is-defun-start |
diff --git a/lispref/text.texi b/lispref/text.texi index 14a9dc9d5c6..1fa68fce917 100644 --- a/lispref/text.texi +++ b/lispref/text.texi | |||
| @@ -1200,8 +1200,8 @@ text in the buffer automatically add elements to the front of the undo | |||
| 1200 | list, which is in the variable @code{buffer-undo-list}. | 1200 | list, which is in the variable @code{buffer-undo-list}. |
| 1201 | 1201 | ||
| 1202 | @defvar buffer-undo-list | 1202 | @defvar buffer-undo-list |
| 1203 | This variable's value is the undo list of the current buffer. | 1203 | This buffer-local variable's value is the undo list of the current |
| 1204 | A value of @code{t} disables the recording of undo information. | 1204 | buffer. A value of @code{t} disables the recording of undo information. |
| 1205 | @end defvar | 1205 | @end defvar |
| 1206 | 1206 | ||
| 1207 | Here are the kinds of elements an undo list can have: | 1207 | Here are the kinds of elements an undo list can have: |
| @@ -1768,8 +1768,8 @@ justify existing text, see @ref{Filling}. | |||
| 1768 | justification style to refill portions of the text. @xref{Margins}. | 1768 | justification style to refill portions of the text. @xref{Margins}. |
| 1769 | 1769 | ||
| 1770 | @defvar auto-fill-function | 1770 | @defvar auto-fill-function |
| 1771 | The value of this variable should be a function (of no arguments) to be | 1771 | The value of this buffer-local variable should be a function (of no |
| 1772 | called after self-inserting a character from the table | 1772 | arguments) to be called after self-inserting a character from the table |
| 1773 | @code{auto-fill-chars}. It may be @code{nil}, in which case nothing | 1773 | @code{auto-fill-chars}. It may be @code{nil}, in which case nothing |
| 1774 | special is done in that case. | 1774 | special is done in that case. |
| 1775 | 1775 | ||
diff --git a/lispref/windows.texi b/lispref/windows.texi index e204a7ce7d0..01e33f1c0d4 100644 --- a/lispref/windows.texi +++ b/lispref/windows.texi | |||
| @@ -717,6 +717,12 @@ based on the local variables of @var{buffer}. However, if | |||
| 717 | widths of @var{window} remain unchanged. @xref{Fringes}. | 717 | widths of @var{window} remain unchanged. @xref{Fringes}. |
| 718 | @end defun | 718 | @end defun |
| 719 | 719 | ||
| 720 | @defvar buffer-display-count | ||
| 721 | This buffer-local variable records the number of times a buffer is | ||
| 722 | displayed in a window. It is incremented each time | ||
| 723 | @code{set-window-buffer} is called for the buffer. | ||
| 724 | @end defvar | ||
| 725 | |||
| 720 | @defun window-buffer &optional window | 726 | @defun window-buffer &optional window |
| 721 | This function returns the buffer that @var{window} is displaying. If | 727 | This function returns the buffer that @var{window} is displaying. If |
| 722 | @var{window} is omitted, this function returns the buffer for the | 728 | @var{window} is omitted, this function returns the buffer for the |