diff options
| author | Glenn Morris | 2012-05-26 18:06:44 -0700 |
|---|---|---|
| committer | Glenn Morris | 2012-05-26 18:06:44 -0700 |
| commit | 33017fafd17d722e82a268e9b272f27df261e09d (patch) | |
| tree | 9c34640f09d51059804961d697ed9b07e19571d3 /doc | |
| parent | caf8a9b2b301aba06735d403317b75b41df59bfe (diff) | |
| parent | ed7bebbb489cf6f893fc35a2a6714b0d8e7e8a90 (diff) | |
| download | emacs-33017fafd17d722e82a268e9b272f27df261e09d.tar.gz emacs-33017fafd17d722e82a268e9b272f27df261e09d.zip | |
Merge from emacs-24; up to 2012-04-24T08:35:02Z!lekktu@gmail.com
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 58 | ||||
| -rw-r--r-- | doc/lispref/commands.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/compile.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/debugging.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/functions.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/markers.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/minibuf.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 34 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/package.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/processes.texi | 6 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/variables.texi | 21 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 4 | ||||
| -rw-r--r-- | doc/misc/ChangeLog | 7 | ||||
| -rw-r--r-- | doc/misc/org.texi | 10 |
20 files changed, 147 insertions, 77 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index c3b50dbdcd5..fbc7d83dfe5 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,61 @@ | |||
| 1 | 2012-05-27 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * functions.texi (Obsolete Functions): | ||
| 4 | Fix doc for set-advertised-calling-convention. | ||
| 5 | |||
| 6 | * modes.texi (Mode Help): Fix describe-mode. | ||
| 7 | |||
| 8 | * display.texi (Face Functions): Fix define-obsolete-face-alias. | ||
| 9 | |||
| 10 | * variables.texi (Variable Aliases): Fix make-obsolete-variable. | ||
| 11 | |||
| 12 | 2012-05-27 Martin Rudalics <rudalics@gmx.at> | ||
| 13 | |||
| 14 | * commands.texi (Recursive Editing): recursive-edit is a command. | ||
| 15 | |||
| 16 | * compile.texi (Docs and Compilation): | ||
| 17 | byte-compile-dynamic-docstrings is an option. | ||
| 18 | |||
| 19 | * debugging.texi (Invoking the Debugger): debug is a command. | ||
| 20 | |||
| 21 | * display.texi (Progress): progress-reporter-update and | ||
| 22 | progress-reporter-force-update have VALUE argument optional. | ||
| 23 | (Animated Images): Use non-@code{nil} instead of non-nil. | ||
| 24 | |||
| 25 | * files.texi (Format Conversion Round-Trip): | ||
| 26 | Use non-@code{nil} instead of non-nil. | ||
| 27 | |||
| 28 | * frames.texi (Creating Frames): make-frame is a command. | ||
| 29 | (Input Focus): select-frame is a command. | ||
| 30 | (Pointer Shape): void-text-area-pointer is an option. | ||
| 31 | |||
| 32 | * help.texi (Describing Characters): read-kbd-macro is a command. | ||
| 33 | (Help Functions): describe-prefix-bindings is a command. | ||
| 34 | |||
| 35 | * markers.texi (Creating Markers): Both arguments of copy-marker | ||
| 36 | are optional. | ||
| 37 | |||
| 38 | * minibuf.texi (Reading File Names): Use @kbd instead of @code. | ||
| 39 | |||
| 40 | * modes.texi (Mode Line Variables): mode-line-remote and | ||
| 41 | mode-line-client are not options. | ||
| 42 | (Imenu): imenu-add-to-menubar is a command. | ||
| 43 | (SMIE Indentation Helpers): Use non-@code{nil} instead of non-nil. | ||
| 44 | |||
| 45 | * os.texi (Sound Output): play-sound-file is a command. | ||
| 46 | |||
| 47 | * package.texi (Package Archives): Use @key{RET} instead of @kbd{RET}. | ||
| 48 | |||
| 49 | * processes.texi (Signals to Processes): | ||
| 50 | Use @key{RET} instead of @code{RET}. | ||
| 51 | (Signals to Processes): signal-process is a command. | ||
| 52 | |||
| 53 | * text.texi (Clickable Text): Use @key{RET} instead of @kbd{RET}. | ||
| 54 | (Base 64): base64-encode-string is not a command while | ||
| 55 | base64-decode-region is. | ||
| 56 | |||
| 57 | * windows.texi (Switching Buffers): pop-to-buffer is a command. | ||
| 58 | |||
| 1 | 2012-05-12 Glenn Morris <rgm@gnu.org> | 59 | 2012-05-12 Glenn Morris <rgm@gnu.org> |
| 2 | 60 | ||
| 3 | * Makefile.in (MKDIR_P): New, set by configure. | 61 | * Makefile.in (MKDIR_P): New, set by configure. |
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 50c345b5b15..f0414429be9 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -3210,7 +3210,7 @@ a recursive edit but also provides the other features of the debugger. | |||
| 3210 | Recursive editing levels are also used when you type @kbd{C-r} in | 3210 | Recursive editing levels are also used when you type @kbd{C-r} in |
| 3211 | @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). | 3211 | @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). |
| 3212 | 3212 | ||
| 3213 | @defun recursive-edit | 3213 | @deffn Command recursive-edit |
| 3214 | @cindex suspend evaluation | 3214 | @cindex suspend evaluation |
| 3215 | This function invokes the editor command loop. It is called | 3215 | This function invokes the editor command loop. It is called |
| 3216 | automatically by the initialization of Emacs, to let the user begin | 3216 | automatically by the initialization of Emacs, to let the user begin |
| @@ -3237,7 +3237,7 @@ then type @kbd{C-M-c} to exit and continue executing @code{simple-rec}. | |||
| 3237 | (simple-rec) | 3237 | (simple-rec) |
| 3238 | @result{} nil | 3238 | @result{} nil |
| 3239 | @end example | 3239 | @end example |
| 3240 | @end defun | 3240 | @end deffn |
| 3241 | 3241 | ||
| 3242 | @deffn Command exit-recursive-edit | 3242 | @deffn Command exit-recursive-edit |
| 3243 | This function exits from the innermost recursive edit (including | 3243 | This function exits from the innermost recursive edit (including |
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index c1e0706bb43..1ed06181e39 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -290,10 +290,10 @@ is by adding this string to the file's first line: | |||
| 290 | -*-byte-compile-dynamic-docstrings: nil;-*- | 290 | -*-byte-compile-dynamic-docstrings: nil;-*- |
| 291 | @end example | 291 | @end example |
| 292 | 292 | ||
| 293 | @defvar byte-compile-dynamic-docstrings | 293 | @defopt byte-compile-dynamic-docstrings |
| 294 | If this is non-@code{nil}, the byte compiler generates compiled files | 294 | If this is non-@code{nil}, the byte compiler generates compiled files |
| 295 | that are set up for dynamic loading of documentation strings. | 295 | that are set up for dynamic loading of documentation strings. |
| 296 | @end defvar | 296 | @end defopt |
| 297 | 297 | ||
| 298 | @node Dynamic Loading | 298 | @node Dynamic Loading |
| 299 | @section Dynamic Loading of Individual Functions | 299 | @section Dynamic Loading of Individual Functions |
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index 3c446b07f60..dc315764c7c 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi | |||
| @@ -447,7 +447,7 @@ erroneously show up in this list. | |||
| 447 | Here we describe in full detail the function @code{debug} that is used | 447 | Here we describe in full detail the function @code{debug} that is used |
| 448 | to invoke the debugger. | 448 | to invoke the debugger. |
| 449 | 449 | ||
| 450 | @defun debug &rest debugger-args | 450 | @deffn Command debug &rest debugger-args |
| 451 | This function enters the debugger. It switches buffers to a buffer | 451 | This function enters the debugger. It switches buffers to a buffer |
| 452 | named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second | 452 | named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second |
| 453 | recursive entry to the debugger, etc.), and fills it with information | 453 | recursive entry to the debugger, etc.), and fills it with information |
| @@ -534,7 +534,7 @@ are printed on the top line of the buffer. You can use this feature to | |||
| 534 | display messages---for example, to remind yourself of the conditions | 534 | display messages---for example, to remind yourself of the conditions |
| 535 | under which @code{debug} is called. | 535 | under which @code{debug} is called. |
| 536 | @end table | 536 | @end table |
| 537 | @end defun | 537 | @end deffn |
| 538 | 538 | ||
| 539 | @node Internals of Debugger | 539 | @node Internals of Debugger |
| 540 | @subsection Internals of the Debugger | 540 | @subsection Internals of the Debugger |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index cafa8ddd18b..229dcaedeff 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -413,7 +413,7 @@ This function calls @code{progress-reporter-update}, so the first | |||
| 413 | message is printed immediately. | 413 | message is printed immediately. |
| 414 | @end defun | 414 | @end defun |
| 415 | 415 | ||
| 416 | @defun progress-reporter-update reporter value | 416 | @defun progress-reporter-update reporter &optional value |
| 417 | This function does the main work of reporting progress of your | 417 | This function does the main work of reporting progress of your |
| 418 | operation. It displays the message of @var{reporter}, followed by | 418 | operation. It displays the message of @var{reporter}, followed by |
| 419 | progress percentage determined by @var{value}. If percentage is zero, | 419 | progress percentage determined by @var{value}. If percentage is zero, |
| @@ -434,7 +434,7 @@ try to reduce the number of calls to it: resulting overhead will most | |||
| 434 | likely negate your effort. | 434 | likely negate your effort. |
| 435 | @end defun | 435 | @end defun |
| 436 | 436 | ||
| 437 | @defun progress-reporter-force-update reporter value &optional new-message | 437 | @defun progress-reporter-force-update reporter &optional value new-message |
| 438 | This function is similar to @code{progress-reporter-update} except | 438 | This function is similar to @code{progress-reporter-update} except |
| 439 | that it prints a message in the echo area unconditionally. | 439 | that it prints a message in the echo area unconditionally. |
| 440 | 440 | ||
| @@ -2662,11 +2662,13 @@ makes @code{modeline} an alias for the @code{mode-line} face. | |||
| 2662 | (put 'modeline 'face-alias 'mode-line) | 2662 | (put 'modeline 'face-alias 'mode-line) |
| 2663 | @end example | 2663 | @end example |
| 2664 | 2664 | ||
| 2665 | @defun define-obsolete-face-alias obsolete-face current-face &optional when | 2665 | @defmac define-obsolete-face-alias obsolete-face current-face when |
| 2666 | This function defines a face alias and marks it as obsolete, indicating | 2666 | This macro defines @code{obsolete-face} as an alias for |
| 2667 | that it may be removed in future. The optional string @var{when} | 2667 | @var{current-face}, and also marks it as obsolete, indicating that it |
| 2668 | indicates when the face was made obsolete (for example, a release number). | 2668 | may be removed in future. @var{when} should be a string indicating |
| 2669 | @end defun | 2669 | when @code{obsolete-face} was made obsolete (usually a version number |
| 2670 | string). | ||
| 2671 | @end defmac | ||
| 2670 | 2672 | ||
| 2671 | @node Auto Faces | 2673 | @node Auto Faces |
| 2672 | @subsection Automatic Face Assignment | 2674 | @subsection Automatic Face Assignment |
| @@ -4904,7 +4906,7 @@ create animation. Currently, Emacs only supports animated GIF files. | |||
| 4904 | The following functions related to animated images are available. | 4906 | The following functions related to animated images are available. |
| 4905 | 4907 | ||
| 4906 | @defun image-animated-p image | 4908 | @defun image-animated-p image |
| 4907 | This function returns non-nil if @var{image} can be animated. | 4909 | This function returns non-@code{nil} if @var{image} can be animated. |
| 4908 | The actual return value is a cons @code{(@var{nimages} . @var{delay})}, | 4910 | The actual return value is a cons @code{(@var{nimages} . @var{delay})}, |
| 4909 | where @var{nimages} is the number of frames and @var{delay} is the | 4911 | where @var{nimages} is the number of frames and @var{delay} is the |
| 4910 | delay in seconds between them. | 4912 | delay in seconds between them. |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 2ee80504b60..7bb2bad0f70 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -3133,10 +3133,10 @@ in the order of appearance in the list. | |||
| 3133 | This command writes the current buffer contents into the file @var{file} | 3133 | This command writes the current buffer contents into the file @var{file} |
| 3134 | in a format based on @var{format}, which is a list of format names. It | 3134 | in a format based on @var{format}, which is a list of format names. It |
| 3135 | constructs the actual format starting from @var{format}, then appending | 3135 | constructs the actual format starting from @var{format}, then appending |
| 3136 | any elements from the value of @code{buffer-file-format} with a non-nil | 3136 | any elements from the value of @code{buffer-file-format} with a |
| 3137 | @var{preserve} flag (see above), if they are not already present in | 3137 | non-@code{nil} @var{preserve} flag (see above), if they are not already |
| 3138 | @var{format}. It then updates @code{buffer-file-format} with this | 3138 | present in @var{format}. It then updates @code{buffer-file-format} with |
| 3139 | format, making it the default for future saves. Except for the | 3139 | this format, making it the default for future saves. Except for the |
| 3140 | @var{format} argument, this command is similar to @code{write-file}. In | 3140 | @var{format} argument, this command is similar to @code{write-file}. In |
| 3141 | particular, @var{confirm} has the same meaning and interactive treatment | 3141 | particular, @var{confirm} has the same meaning and interactive treatment |
| 3142 | as the corresponding argument to @code{write-file}. @xref{Definition of | 3142 | as the corresponding argument to @code{write-file}. @xref{Definition of |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 2ff4df55669..330fb654b89 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -108,7 +108,7 @@ for @code{framep} above. | |||
| 108 | 108 | ||
| 109 | To create a new frame, call the function @code{make-frame}. | 109 | To create a new frame, call the function @code{make-frame}. |
| 110 | 110 | ||
| 111 | @defun make-frame &optional alist | 111 | @deffn Command make-frame &optional alist |
| 112 | This function creates and returns a new frame, displaying the current | 112 | This function creates and returns a new frame, displaying the current |
| 113 | buffer. | 113 | buffer. |
| 114 | 114 | ||
| @@ -134,7 +134,7 @@ This function itself does not make the new frame the selected frame. | |||
| 134 | @xref{Input Focus}. The previously selected frame remains selected. | 134 | @xref{Input Focus}. The previously selected frame remains selected. |
| 135 | On graphical terminals, however, the windowing system may select the | 135 | On graphical terminals, however, the windowing system may select the |
| 136 | new frame for its own reasons. | 136 | new frame for its own reasons. |
| 137 | @end defun | 137 | @end deffn |
| 138 | 138 | ||
| 139 | @defvar before-make-frame-hook | 139 | @defvar before-make-frame-hook |
| 140 | A normal hook run by @code{make-frame} before it creates the frame. | 140 | A normal hook run by @code{make-frame} before it creates the frame. |
| @@ -1395,7 +1395,7 @@ same meaning as for @code{select-frame} (see below). The return value | |||
| 1395 | of this function is not significant. | 1395 | of this function is not significant. |
| 1396 | @end defun | 1396 | @end defun |
| 1397 | 1397 | ||
| 1398 | @defun select-frame frame &optional norecord | 1398 | @deffn Command select-frame frame &optional norecord |
| 1399 | This function selects frame @var{frame}, temporarily disregarding the | 1399 | This function selects frame @var{frame}, temporarily disregarding the |
| 1400 | focus of the X server if any. The selection of @var{frame} lasts until | 1400 | focus of the X server if any. The selection of @var{frame} lasts until |
| 1401 | the next time the user does something to select a different frame, or | 1401 | the next time the user does something to select a different frame, or |
| @@ -1418,7 +1418,7 @@ been deleted. | |||
| 1418 | In general, you should never use @code{select-frame} in a way that | 1418 | In general, you should never use @code{select-frame} in a way that |
| 1419 | could switch to a different terminal without switching back when | 1419 | could switch to a different terminal without switching back when |
| 1420 | you're done. | 1420 | you're done. |
| 1421 | @end defun | 1421 | @end deffn |
| 1422 | 1422 | ||
| 1423 | Emacs cooperates with the window system by arranging to select frames as | 1423 | Emacs cooperates with the window system by arranging to select frames as |
| 1424 | the server and window manager request. It does so by generating a | 1424 | the server and window manager request. It does so by generating a |
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index 5e393a399d3..5dce59cc2d6 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi | |||
| @@ -1178,12 +1178,14 @@ equivalent to the following: | |||
| 1178 | In addition, you can mark a certain a particular calling convention | 1178 | In addition, you can mark a certain a particular calling convention |
| 1179 | for a function as obsolete: | 1179 | for a function as obsolete: |
| 1180 | 1180 | ||
| 1181 | @defun set-advertised-calling-convention function signature | 1181 | @defun set-advertised-calling-convention function signature when |
| 1182 | This function specifies the argument list @var{signature} as the | 1182 | This function specifies the argument list @var{signature} as the |
| 1183 | correct way to call @var{function}. This causes the Emacs byte | 1183 | correct way to call @var{function}. This causes the Emacs byte |
| 1184 | compiler to issue a warning whenever it comes across an Emacs Lisp | 1184 | compiler to issue a warning whenever it comes across an Emacs Lisp |
| 1185 | program that calls @var{function} any other way (however, it will | 1185 | program that calls @var{function} any other way (however, it will |
| 1186 | still allow the code to be byte compiled). | 1186 | still allow the code to be byte compiled). @var{when} should be a |
| 1187 | string indicating when the variable was first made obsolete (usually a | ||
| 1188 | version number string). | ||
| 1187 | 1189 | ||
| 1188 | For instance, in old versions of Emacs the @code{sit-for} function | 1190 | For instance, in old versions of Emacs the @code{sit-for} function |
| 1189 | accepted three arguments, like this | 1191 | accepted three arguments, like this |
| @@ -1198,7 +1200,7 @@ this: | |||
| 1198 | 1200 | ||
| 1199 | @example | 1201 | @example |
| 1200 | (set-advertised-calling-convention | 1202 | (set-advertised-calling-convention |
| 1201 | 'sit-for '(seconds &optional nodisp)) | 1203 | 'sit-for '(seconds &optional nodisp) "22.1") |
| 1202 | @end example | 1204 | @end example |
| 1203 | @end defun | 1205 | @end defun |
| 1204 | 1206 | ||
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 762b42113f2..d6d69fcc483 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -511,7 +511,7 @@ for Meta. | |||
| 511 | @end smallexample | 511 | @end smallexample |
| 512 | @end defun | 512 | @end defun |
| 513 | 513 | ||
| 514 | @defun read-kbd-macro string &optional need-vector | 514 | @deffn Command read-kbd-macro string &optional need-vector |
| 515 | This function is used mainly for operating on keyboard macros, but it | 515 | This function is used mainly for operating on keyboard macros, but it |
| 516 | can also be used as a rough inverse for @code{key-description}. You | 516 | can also be used as a rough inverse for @code{key-description}. You |
| 517 | call it with a string containing key descriptions, separated by spaces; | 517 | call it with a string containing key descriptions, separated by spaces; |
| @@ -519,7 +519,7 @@ it returns a string or vector containing the corresponding events. | |||
| 519 | (This may or may not be a single valid key sequence, depending on what | 519 | (This may or may not be a single valid key sequence, depending on what |
| 520 | events you use; @pxref{Key Sequences}.) If @var{need-vector} is | 520 | events you use; @pxref{Key Sequences}.) If @var{need-vector} is |
| 521 | non-@code{nil}, the return value is always a vector. | 521 | non-@code{nil}, the return value is always a vector. |
| 522 | @end defun | 522 | @end deffn |
| 523 | 523 | ||
| 524 | @node Help Functions | 524 | @node Help Functions |
| 525 | @section Help Functions | 525 | @section Help Functions |
| @@ -626,12 +626,12 @@ character, and the help character has no binding after that prefix. The | |||
| 626 | variable's default value is @code{describe-prefix-bindings}. | 626 | variable's default value is @code{describe-prefix-bindings}. |
| 627 | @end defvar | 627 | @end defvar |
| 628 | 628 | ||
| 629 | @defun describe-prefix-bindings | 629 | @deffn Command describe-prefix-bindings |
| 630 | This function calls @code{describe-bindings} to display a list of all | 630 | This function calls @code{describe-bindings} to display a list of all |
| 631 | the subcommands of the prefix key of the most recent key sequence. The | 631 | the subcommands of the prefix key of the most recent key sequence. The |
| 632 | prefix described consists of all but the last event of that key | 632 | prefix described consists of all but the last event of that key |
| 633 | sequence. (The last event is, presumably, the help character.) | 633 | sequence. (The last event is, presumably, the help character.) |
| 634 | @end defun | 634 | @end deffn |
| 635 | 635 | ||
| 636 | The following two functions are meant for modes that want to provide | 636 | The following two functions are meant for modes that want to provide |
| 637 | help without relinquishing control, such as the ``electric'' modes. | 637 | help without relinquishing control, such as the ``electric'' modes. |
diff --git a/doc/lispref/markers.texi b/doc/lispref/markers.texi index ba9d429314d..a1fef662a29 100644 --- a/doc/lispref/markers.texi +++ b/doc/lispref/markers.texi | |||
| @@ -205,7 +205,7 @@ chapter. | |||
| 205 | @end example | 205 | @end example |
| 206 | @end defun | 206 | @end defun |
| 207 | 207 | ||
| 208 | @defun copy-marker marker-or-integer &optional insertion-type | 208 | @defun copy-marker &optional marker-or-integer insertion-type |
| 209 | If passed a marker as its argument, @code{copy-marker} returns a | 209 | If passed a marker as its argument, @code{copy-marker} returns a |
| 210 | new marker that points to the same place and the same buffer as does | 210 | new marker that points to the same place and the same buffer as does |
| 211 | @var{marker-or-integer}. If passed an integer as its argument, | 211 | @var{marker-or-integer}. If passed an integer as its argument, |
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index 99118af19c7..6e66b6541a2 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -1404,7 +1404,7 @@ returns the pre-inserted contents of the minibuffer. | |||
| 1404 | If the user types @key{RET} in an empty minibuffer, this function | 1404 | If the user types @key{RET} in an empty minibuffer, this function |
| 1405 | returns an empty string, regardless of the value of | 1405 | returns an empty string, regardless of the value of |
| 1406 | @var{require-match}. This is, for instance, how the user can make the | 1406 | @var{require-match}. This is, for instance, how the user can make the |
| 1407 | current buffer visit no file using @code{M-x set-visited-file-name}. | 1407 | current buffer visit no file using @kbd{M-x set-visited-file-name}. |
| 1408 | 1408 | ||
| 1409 | If @var{predicate} is non-@code{nil}, it specifies a function of one | 1409 | If @var{predicate} is non-@code{nil}, it specifies a function of one |
| 1410 | argument that decides which file names are acceptable completion | 1410 | argument that decides which file names are acceptable completion |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 00cd43d7b71..81e860ed5a7 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -734,13 +734,15 @@ modes. It is normally bound to @kbd{C-h m}. It uses the value of the | |||
| 734 | variable @code{major-mode} (@pxref{Major Modes}), which is why every | 734 | variable @code{major-mode} (@pxref{Major Modes}), which is why every |
| 735 | major mode command needs to set that variable. | 735 | major mode command needs to set that variable. |
| 736 | 736 | ||
| 737 | @deffn Command describe-mode | 737 | @deffn Command describe-mode &optional buffer |
| 738 | This function displays the documentation of the current major mode. | 738 | This command displays the documentation of the current buffer's major |
| 739 | 739 | mode and minor modes. It uses the @code{documentation} function to | |
| 740 | The @code{describe-mode} function calls the @code{documentation} | 740 | retrieve the documentation strings of the major and minor mode |
| 741 | function using the value of @code{major-mode} as an argument. Thus, it | 741 | commands (@pxref{Accessing Documentation}). |
| 742 | displays the documentation string of the major mode command. | 742 | |
| 743 | (@xref{Accessing Documentation}.) | 743 | If called from Lisp with a non-nil @var{buffer} argument, this |
| 744 | function displays the documentation for that buffer's major and minor | ||
| 745 | modes, rather than those of the current buffer. | ||
| 744 | @end deffn | 746 | @end deffn |
| 745 | 747 | ||
| 746 | @node Derived Modes | 748 | @node Derived Modes |
| @@ -1990,14 +1992,14 @@ default value also displays the recursive editing level, information | |||
| 1990 | on the process status, and whether narrowing is in effect. | 1992 | on the process status, and whether narrowing is in effect. |
| 1991 | @end defopt | 1993 | @end defopt |
| 1992 | 1994 | ||
| 1993 | @defopt mode-line-remote | 1995 | @defvar mode-line-remote |
| 1994 | This variable is used to show whether @code{default-directory} for the | 1996 | This variable is used to show whether @code{default-directory} for the |
| 1995 | current buffer is remote. | 1997 | current buffer is remote. |
| 1996 | @end defopt | 1998 | @end defvar |
| 1997 | 1999 | ||
| 1998 | @defopt mode-line-client | 2000 | @defvar mode-line-client |
| 1999 | This variable is used to identify @code{emacsclient} frames. | 2001 | This variable is used to identify @code{emacsclient} frames. |
| 2000 | @end defopt | 2002 | @end defvar |
| 2001 | 2003 | ||
| 2002 | The following three variables are used in @code{mode-line-modes}: | 2004 | The following three variables are used in @code{mode-line-modes}: |
| 2003 | 2005 | ||
| @@ -2315,10 +2317,10 @@ definitions, or other named portions of the buffer; then the user can | |||
| 2315 | choose one of them and move point to it. Major modes can add a menu | 2317 | choose one of them and move point to it. Major modes can add a menu |
| 2316 | bar item to use Imenu using @code{imenu-add-to-menubar}. | 2318 | bar item to use Imenu using @code{imenu-add-to-menubar}. |
| 2317 | 2319 | ||
| 2318 | @defun imenu-add-to-menubar name | 2320 | @deffn Command imenu-add-to-menubar name |
| 2319 | This function defines a local menu bar item named @var{name} | 2321 | This function defines a local menu bar item named @var{name} |
| 2320 | to run Imenu. | 2322 | to run Imenu. |
| 2321 | @end defun | 2323 | @end deffn |
| 2322 | 2324 | ||
| 2323 | The user-level commands for using Imenu are described in the Emacs | 2325 | The user-level commands for using Imenu are described in the Emacs |
| 2324 | Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}). This section | 2326 | Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}). This section |
| @@ -3860,9 +3862,9 @@ Return non-@code{nil} if the current token's parent is among @var{parents}. | |||
| 3860 | @end defun | 3862 | @end defun |
| 3861 | 3863 | ||
| 3862 | @defun smie-rule-sibling-p | 3864 | @defun smie-rule-sibling-p |
| 3863 | Return non-nil if the current token's parent is actually a sibling. | 3865 | Return non-@code{nil} if the current token's parent is actually a |
| 3864 | This is the case for example when the parent of a @code{","} is just the | 3866 | sibling. This is the case for example when the parent of a @code{","} |
| 3865 | previous @code{","}. | 3867 | is just the previous @code{","}. |
| 3866 | @end defun | 3868 | @end defun |
| 3867 | 3869 | ||
| 3868 | @defun smie-rule-parent &optional offset | 3870 | @defun smie-rule-parent &optional offset |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index ac6711f4827..dd2fb17ab15 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -2108,10 +2108,10 @@ calls the functions in the list @code{play-sound-functions}. | |||
| 2108 | Each function is called with one argument, @var{sound}. | 2108 | Each function is called with one argument, @var{sound}. |
| 2109 | @end defun | 2109 | @end defun |
| 2110 | 2110 | ||
| 2111 | @defun play-sound-file file &optional volume device | 2111 | @deffn Command play-sound-file file &optional volume device |
| 2112 | This function is an alternative interface to playing a sound @var{file} | 2112 | This function is an alternative interface to playing a sound @var{file} |
| 2113 | specifying an optional @var{volume} and @var{device}. | 2113 | specifying an optional @var{volume} and @var{device}. |
| 2114 | @end defun | 2114 | @end deffn |
| 2115 | 2115 | ||
| 2116 | @defvar play-sound-functions | 2116 | @defvar play-sound-functions |
| 2117 | A list of functions to be called before playing a sound. Each function | 2117 | A list of functions to be called before playing a sound. Each function |
diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi index 7c6d41b8e23..ad2b8fd6210 100644 --- a/doc/lispref/package.texi +++ b/doc/lispref/package.texi | |||
| @@ -294,8 +294,8 @@ How to accomplish this is beyond the scope of this manual. | |||
| 294 | 294 | ||
| 295 | A convenient way to set up and update a package archive is via the | 295 | A convenient way to set up and update a package archive is via the |
| 296 | @code{package-x} library. This is included with Emacs, but not loaded | 296 | @code{package-x} library. This is included with Emacs, but not loaded |
| 297 | by default; type @kbd{M-x load-library @kbd{RET} package-x @kbd{RET}} | 297 | by default; type @kbd{M-x load-library @key{RET} package-x @key{RET}} to |
| 298 | to load it, or add @code{(require 'package-x)} to your init file. | 298 | load it, or add @code{(require 'package-x)} to your init file. |
| 299 | @xref{Lisp Libraries,, Lisp Libraries, emacs, The GNU Emacs Manual}. | 299 | @xref{Lisp Libraries,, Lisp Libraries, emacs, The GNU Emacs Manual}. |
| 300 | Once loaded, you can make use of the following: | 300 | Once loaded, you can make use of the following: |
| 301 | 301 | ||
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index ea68cf9ce96..dbb939583a6 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi | |||
| @@ -1073,7 +1073,7 @@ job-control shells won't work when a pipe is used. See | |||
| 1073 | @defun interrupt-process &optional process current-group | 1073 | @defun interrupt-process &optional process current-group |
| 1074 | This function interrupts the process @var{process} by sending the | 1074 | This function interrupts the process @var{process} by sending the |
| 1075 | signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt | 1075 | signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt |
| 1076 | character'' (normally @kbd{C-c} on some systems, and @code{DEL} on | 1076 | character'' (normally @kbd{C-c} on some systems, and @key{DEL} on |
| 1077 | others) sends this signal. When the argument @var{current-group} is | 1077 | others) sends this signal. When the argument @var{current-group} is |
| 1078 | non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' | 1078 | non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' |
| 1079 | on the terminal by which Emacs talks to the subprocess. | 1079 | on the terminal by which Emacs talks to the subprocess. |
| @@ -1112,7 +1112,7 @@ it the signal @code{SIGCONT}. This presumes that @var{process} was | |||
| 1112 | stopped previously. | 1112 | stopped previously. |
| 1113 | @end defun | 1113 | @end defun |
| 1114 | 1114 | ||
| 1115 | @defun signal-process process signal | 1115 | @deffn Command signal-process process signal |
| 1116 | This function sends a signal to process @var{process}. The argument | 1116 | This function sends a signal to process @var{process}. The argument |
| 1117 | @var{signal} specifies which signal to send; it should be an integer, | 1117 | @var{signal} specifies which signal to send; it should be an integer, |
| 1118 | or a symbol whose name is a signal. | 1118 | or a symbol whose name is a signal. |
| @@ -1120,7 +1120,7 @@ or a symbol whose name is a signal. | |||
| 1120 | The @var{process} argument can be a system process @acronym{ID} (an | 1120 | The @var{process} argument can be a system process @acronym{ID} (an |
| 1121 | integer); that allows you to send signals to processes that are not | 1121 | integer); that allows you to send signals to processes that are not |
| 1122 | children of Emacs. @xref{System Processes}. | 1122 | children of Emacs. @xref{System Processes}. |
| 1123 | @end defun | 1123 | @end deffn |
| 1124 | 1124 | ||
| 1125 | @node Output from Processes | 1125 | @node Output from Processes |
| 1126 | @section Receiving Output from Processes | 1126 | @section Receiving Output from Processes |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 09ea37a96ba..8a656dc3ef6 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3530,7 +3530,7 @@ properties. For simplicity, we will refer to the clickable text as a | |||
| 3530 | @dfn{link}. | 3530 | @dfn{link}. |
| 3531 | 3531 | ||
| 3532 | Implementing a link involves three separate steps: (1) indicating | 3532 | Implementing a link involves three separate steps: (1) indicating |
| 3533 | clickability when the mouse moves over the link; (2) making @kbd{RET} | 3533 | clickability when the mouse moves over the link; (2) making @key{RET} |
| 3534 | or @kbd{Mouse-2} on that link do something; and (3) setting up a | 3534 | or @kbd{Mouse-2} on that link do something; and (3) setting up a |
| 3535 | @code{follow-link} condition so that the link obeys | 3535 | @code{follow-link} condition so that the link obeys |
| 3536 | @code{mouse-1-click-follows-link}. | 3536 | @code{mouse-1-click-follows-link}. |
| @@ -4068,7 +4068,7 @@ text, to avoid overlong lines. However, if the optional argument | |||
| 4068 | the output is just one long line. | 4068 | the output is just one long line. |
| 4069 | @end deffn | 4069 | @end deffn |
| 4070 | 4070 | ||
| 4071 | @deffn Command base64-encode-string string &optional no-line-break | 4071 | @defun base64-encode-string string &optional no-line-break |
| 4072 | This function converts the string @var{string} into base 64 code. It | 4072 | This function converts the string @var{string} into base 64 code. It |
| 4073 | returns a string containing the encoded text. As for | 4073 | returns a string containing the encoded text. As for |
| 4074 | @code{base64-encode-region}, an error is signaled if a character in the | 4074 | @code{base64-encode-region}, an error is signaled if a character in the |
| @@ -4078,15 +4078,15 @@ Normally, this function inserts newline characters into the encoded | |||
| 4078 | text, to avoid overlong lines. However, if the optional argument | 4078 | text, to avoid overlong lines. However, if the optional argument |
| 4079 | @var{no-line-break} is non-@code{nil}, these newlines are not added, so | 4079 | @var{no-line-break} is non-@code{nil}, these newlines are not added, so |
| 4080 | the result string is just one long line. | 4080 | the result string is just one long line. |
| 4081 | @end deffn | 4081 | @end defun |
| 4082 | 4082 | ||
| 4083 | @defun base64-decode-region beg end | 4083 | @deffn Command base64-decode-region beg end |
| 4084 | This function converts the region from @var{beg} to @var{end} from base | 4084 | This function converts the region from @var{beg} to @var{end} from base |
| 4085 | 64 code into the corresponding decoded text. It returns the length of | 4085 | 64 code into the corresponding decoded text. It returns the length of |
| 4086 | the decoded text. | 4086 | the decoded text. |
| 4087 | 4087 | ||
| 4088 | The decoding functions ignore newline characters in the encoded text. | 4088 | The decoding functions ignore newline characters in the encoded text. |
| 4089 | @end defun | 4089 | @end deffn |
| 4090 | 4090 | ||
| 4091 | @defun base64-decode-string string | 4091 | @defun base64-decode-string string |
| 4092 | This function converts the string @var{string} from base 64 code into | 4092 | This function converts the string @var{string} from base 64 code into |
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi index 4e622231645..0be496a3c46 100644 --- a/doc/lispref/variables.texi +++ b/doc/lispref/variables.texi | |||
| @@ -1852,16 +1852,19 @@ variable with a new name. @code{make-obsolete-variable} declares that | |||
| 1852 | the old name is obsolete and therefore that it may be removed at some | 1852 | the old name is obsolete and therefore that it may be removed at some |
| 1853 | stage in the future. | 1853 | stage in the future. |
| 1854 | 1854 | ||
| 1855 | @defun make-obsolete-variable obsolete-name current-name &optional when | 1855 | @defun make-obsolete-variable obsolete-name current-name when &optional access-type |
| 1856 | This function makes the byte compiler warn that the variable | 1856 | This function makes the byte compiler warn that the variable |
| 1857 | @var{obsolete-name} is obsolete. If @var{current-name} is a symbol, it is | 1857 | @var{obsolete-name} is obsolete. If @var{current-name} is a symbol, |
| 1858 | the variable's new name; then the warning message says to use | 1858 | it is the variable's new name; then the warning message says to use |
| 1859 | @var{current-name} instead of @var{obsolete-name}. If @var{current-name} | 1859 | @var{current-name} instead of @var{obsolete-name}. If |
| 1860 | is a string, this is the message and there is no replacement variable. | 1860 | @var{current-name} is a string, this is the message and there is no |
| 1861 | 1861 | replacement variable. @var{when} should be a string indicating when | |
| 1862 | If provided, @var{when} should be a string indicating when the | 1862 | the variable was first made obsolete (usually a version number |
| 1863 | variable was first made obsolete---for example, a date or a release | 1863 | string). |
| 1864 | number. | 1864 | |
| 1865 | The optional argument @var{access-type}, if non-@code{nil}, should | ||
| 1866 | should specify the kind of access that will trigger obsolescence | ||
| 1867 | warnings; it can be either @code{get} or @code{set}. | ||
| 1865 | @end defun | 1868 | @end defun |
| 1866 | 1869 | ||
| 1867 | You can make two variables synonyms and declare one obsolete at the | 1870 | You can make two variables synonyms and declare one obsolete at the |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 094729033b1..b4aeaf26ee1 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -1558,7 +1558,7 @@ displaying the buffer. Hence, all the variables affecting | |||
| 1558 | @code{display-buffer} will affect it as well. @xref{Choosing Window}, | 1558 | @code{display-buffer} will affect it as well. @xref{Choosing Window}, |
| 1559 | for the documentation of @code{display-buffer}. | 1559 | for the documentation of @code{display-buffer}. |
| 1560 | 1560 | ||
| 1561 | @defun pop-to-buffer buffer-or-name &optional action norecord | 1561 | @deffn Command pop-to-buffer buffer-or-name &optional action norecord |
| 1562 | This function makes @var{buffer-or-name} the current buffer and | 1562 | This function makes @var{buffer-or-name} the current buffer and |
| 1563 | displays it in some window, preferably not the window previously | 1563 | displays it in some window, preferably not the window previously |
| 1564 | selected. It then selects the displaying window. If that window is | 1564 | selected. It then selects the displaying window. If that window is |
| @@ -1581,7 +1581,7 @@ displayed in the selected window. | |||
| 1581 | 1581 | ||
| 1582 | Like @code{switch-to-buffer}, this function updates the buffer list | 1582 | Like @code{switch-to-buffer}, this function updates the buffer list |
| 1583 | unless @var{norecord} is non-@code{nil}. | 1583 | unless @var{norecord} is non-@code{nil}. |
| 1584 | @end defun | 1584 | @end deffn |
| 1585 | 1585 | ||
| 1586 | @node Choosing Window | 1586 | @node Choosing Window |
| 1587 | @section Choosing a Window for Display | 1587 | @section Choosing a Window for Display |
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index a10f65b085c..82e6a2f70ae 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,7 +1,10 @@ | |||
| 1 | 2012-05-27 Bastien Guerry <bzg@gnu.org> | ||
| 2 | |||
| 3 | * org.texi (Durations and time values): Fix typo. | ||
| 4 | |||
| 1 | 2012-05-19 Jay Belanger <jay.p.belanger@gmail.com> | 5 | 2012-05-19 Jay Belanger <jay.p.belanger@gmail.com> |
| 2 | 6 | ||
| 3 | * doc/misc/calc.texi | 7 | * doc/misc/calc.texi (Basic Operations on Units, Customizing Calc): |
| 4 | (Basic Operations on Units, Customizing Calc): | ||
| 5 | Mention `calc-ensure-consistent-units'. | 8 | Mention `calc-ensure-consistent-units'. |
| 6 | 9 | ||
| 7 | 2012-05-14 Andreas Schwab <schwab@linux-m68k.org> | 10 | 2012-05-14 Andreas Schwab <schwab@linux-m68k.org> |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 775ff638eef..575b9cbebe6 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -4,8 +4,8 @@ | |||
| 4 | @setfilename ../../info/org | 4 | @setfilename ../../info/org |
| 5 | @settitle The Org Manual | 5 | @settitle The Org Manual |
| 6 | 6 | ||
| 7 | @set VERSION 7.8.09 | 7 | @set VERSION 7.8.11 |
| 8 | @set DATE April 2012 | 8 | @set DATE May 2012 |
| 9 | 9 | ||
| 10 | @c Use proper quote and backtick for code sections in PDF output | 10 | @c Use proper quote and backtick for code sections in PDF output |
| 11 | @c Cf. Texinfo manual 14.2 | 11 | @c Cf. Texinfo manual 14.2 |
| @@ -2625,7 +2625,7 @@ formulas or Elisp formulas: | |||
| 2625 | 2625 | ||
| 2626 | Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds | 2626 | Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds |
| 2627 | are optional. With the @code{T} flag, computed durations will be displayed | 2627 | are optional. With the @code{T} flag, computed durations will be displayed |
| 2628 | as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag, | 2628 | as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag, |
| 2629 | computed durations will be displayed according to the value of the variable | 2629 | computed durations will be displayed according to the value of the variable |
| 2630 | @code{org-table-duration-custom-format}, which defaults to @code{'hours} and | 2630 | @code{org-table-duration-custom-format}, which defaults to @code{'hours} and |
| 2631 | will display the result as a fraction of hours (see the second formula in the | 2631 | will display the result as a fraction of hours (see the second formula in the |
| @@ -7900,9 +7900,9 @@ Interactively select another agenda view and append it to the current view. | |||
| 7900 | Delete other windows. | 7900 | Delete other windows. |
| 7901 | @c | 7901 | @c |
| 7902 | @orgcmdkskc{v d,d,org-agenda-day-view} | 7902 | @orgcmdkskc{v d,d,org-agenda-day-view} |
| 7903 | @xorgcmdkskc{v w,w,org-agenda-day-view} | 7903 | @xorgcmdkskc{v w,w,org-agenda-week-view} |
| 7904 | @xorgcmd{v m,org-agenda-month-view} | 7904 | @xorgcmd{v m,org-agenda-month-view} |
| 7905 | @xorgcmd{v y,org-agenda-month-year} | 7905 | @xorgcmd{v y,org-agenda-year-view} |
| 7906 | @xorgcmd{v SPC,org-agenda-reset-view} | 7906 | @xorgcmd{v SPC,org-agenda-reset-view} |
| 7907 | @vindex org-agenda-span | 7907 | @vindex org-agenda-span |
| 7908 | Switch to day/week/month/year view. When switching to day or week view, this | 7908 | Switch to day/week/month/year view. When switching to day or week view, this |