diff options
| author | Chong Yidong | 2012-09-22 23:24:26 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-09-22 23:24:26 +0800 |
| commit | c88b867fecbd50140b0b41f05599811a8f0e3dfe (patch) | |
| tree | 945c6c88a7ce2029d13af7007239e8253e1e6a44 /src | |
| parent | bb4d86b40c61443608280df3d0668d44845177a5 (diff) | |
| download | emacs-c88b867fecbd50140b0b41f05599811a8f0e3dfe.tar.gz emacs-c88b867fecbd50140b0b41f05599811a8f0e3dfe.zip | |
Misc doc fixes.
* searching.texi (Replacing Match): Minor clarification.
* lisp/repeat.el (repeat): Doc fix.
* lisp/simple.el (shell-command-on-region): Doc fix.
* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc fix.
* cmds.c (Fforward_char, Fbackward_char): Doc fix.
* editfns.c (Fline_beginning_position): Doc fix.
(Fline_end_position): Doc fix.
* minibuf.c (Finternal_complete_buffer): Doc fix.
* search.c (Freplace_match): Doc fix.
Fixes: debbugs:12325 debbugs:12391 debbugs:12416 debbugs:12414 debbugs:10909 debbugs:12348
Diffstat (limited to 'src')
| -rw-r--r-- | src/ChangeLog | 11 | ||||
| -rw-r--r-- | src/cmds.c | 2 | ||||
| -rw-r--r-- | src/editfns.c | 18 | ||||
| -rw-r--r-- | src/minibuf.c | 8 | ||||
| -rw-r--r-- | src/search.c | 29 |
5 files changed, 40 insertions, 28 deletions
diff --git a/src/ChangeLog b/src/ChangeLog index b2f33494b7c..9d8bc3a7c00 100644 --- a/src/ChangeLog +++ b/src/ChangeLog | |||
| @@ -1,5 +1,16 @@ | |||
| 1 | 2012-09-22 Chong Yidong <cyd@gnu.org> | 1 | 2012-09-22 Chong Yidong <cyd@gnu.org> |
| 2 | 2 | ||
| 3 | * search.c (Freplace_match): Doc fix (Bug#12325). | ||
| 4 | |||
| 5 | * minibuf.c (Finternal_complete_buffer): Doc fix (Bug#12391). | ||
| 6 | |||
| 7 | * editfns.c (Fline_beginning_position): Doc fix (Bug#12416). | ||
| 8 | (Fline_end_position): Doc fix. | ||
| 9 | |||
| 10 | * cmds.c (Fforward_char, Fbackward_char): Doc fix (Bug#12414). | ||
| 11 | |||
| 12 | 2012-09-22 Chong Yidong <cyd@gnu.org> | ||
| 13 | |||
| 3 | * dispextern.h (struct image_type): Add new slot, storing a type | 14 | * dispextern.h (struct image_type): Add new slot, storing a type |
| 4 | initialization function. | 15 | initialization function. |
| 5 | 16 | ||
diff --git a/src/cmds.c b/src/cmds.c index 45f7df948ae..453a4b67e57 100644 --- a/src/cmds.c +++ b/src/cmds.c | |||
| @@ -85,6 +85,7 @@ move_point (Lisp_Object n, bool forward) | |||
| 85 | DEFUN ("forward-char", Fforward_char, Sforward_char, 0, 1, "^p", | 85 | DEFUN ("forward-char", Fforward_char, Sforward_char, 0, 1, "^p", |
| 86 | doc: /* Move point N characters forward (backward if N is negative). | 86 | doc: /* Move point N characters forward (backward if N is negative). |
| 87 | On reaching end or beginning of buffer, stop and signal error. | 87 | On reaching end or beginning of buffer, stop and signal error. |
| 88 | Interactively, N is the numeric prefix argument. | ||
| 88 | 89 | ||
| 89 | Depending on the bidirectional context, the movement may be to the | 90 | Depending on the bidirectional context, the movement may be to the |
| 90 | right or to the left on the screen. This is in contrast with | 91 | right or to the left on the screen. This is in contrast with |
| @@ -97,6 +98,7 @@ right or to the left on the screen. This is in contrast with | |||
| 97 | DEFUN ("backward-char", Fbackward_char, Sbackward_char, 0, 1, "^p", | 98 | DEFUN ("backward-char", Fbackward_char, Sbackward_char, 0, 1, "^p", |
| 98 | doc: /* Move point N characters backward (forward if N is negative). | 99 | doc: /* Move point N characters backward (forward if N is negative). |
| 99 | On attempt to pass beginning or end of buffer, stop and signal error. | 100 | On attempt to pass beginning or end of buffer, stop and signal error. |
| 101 | Interactively, N is the numeric prefix argument. | ||
| 100 | 102 | ||
| 101 | Depending on the bidirectional context, the movement may be to the | 103 | Depending on the bidirectional context, the movement may be to the |
| 102 | right or to the left on the screen. This is in contrast with | 104 | right or to the left on the screen. This is in contrast with |
diff --git a/src/editfns.c b/src/editfns.c index c6744648bc5..acf9c48e7a0 100644 --- a/src/editfns.c +++ b/src/editfns.c | |||
| @@ -738,17 +738,18 @@ Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */) | |||
| 738 | DEFUN ("line-beginning-position", | 738 | DEFUN ("line-beginning-position", |
| 739 | Fline_beginning_position, Sline_beginning_position, 0, 1, 0, | 739 | Fline_beginning_position, Sline_beginning_position, 0, 1, 0, |
| 740 | doc: /* Return the character position of the first character on the current line. | 740 | doc: /* Return the character position of the first character on the current line. |
| 741 | With argument N not nil or 1, move forward N - 1 lines first. | 741 | With optional argument N, scan forward N - 1 lines first. |
| 742 | If scan reaches end of buffer, return that position. | 742 | If the scan reaches the end of the buffer, return that position. |
| 743 | 743 | ||
| 744 | The returned position is of the first character in the logical order, | 744 | This function ignores text display directionality; it returns the |
| 745 | i.e. the one that has the smallest character position. | 745 | position of the first character in logical order, i.e. the smallest |
| 746 | character position on the line. | ||
| 746 | 747 | ||
| 747 | This function constrains the returned position to the current field | 748 | This function constrains the returned position to the current field |
| 748 | unless that would be on a different line than the original, | 749 | unless that position would be on a different line than the original, |
| 749 | unconstrained result. If N is nil or 1, and a front-sticky field | 750 | unconstrained result. If N is nil or 1, and a front-sticky field |
| 750 | starts at point, the scan stops as soon as it starts. To ignore field | 751 | starts at point, the scan stops as soon as it starts. To ignore field |
| 751 | boundaries bind `inhibit-field-text-motion' to t. | 752 | boundaries, bind `inhibit-field-text-motion' to t. |
| 752 | 753 | ||
| 753 | This function does not move point. */) | 754 | This function does not move point. */) |
| 754 | (Lisp_Object n) | 755 | (Lisp_Object n) |
| @@ -782,8 +783,9 @@ DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0, | |||
| 782 | With argument N not nil or 1, move forward N - 1 lines first. | 783 | With argument N not nil or 1, move forward N - 1 lines first. |
| 783 | If scan reaches end of buffer, return that position. | 784 | If scan reaches end of buffer, return that position. |
| 784 | 785 | ||
| 785 | The returned position is of the last character in the logical order, | 786 | This function ignores text display directionality; it returns the |
| 786 | i.e. the character whose buffer position is the largest one. | 787 | position of the last character in logical order, i.e. the largest |
| 788 | character position on the line. | ||
| 787 | 789 | ||
| 788 | This function constrains the returned position to the current field | 790 | This function constrains the returned position to the current field |
| 789 | unless that would be on a different line than the original, | 791 | unless that would be on a different line than the original, |
diff --git a/src/minibuf.c b/src/minibuf.c index 8a1e0ddde86..6f9c61dcfb1 100644 --- a/src/minibuf.c +++ b/src/minibuf.c | |||
| @@ -1862,11 +1862,11 @@ static Lisp_Object Qmetadata; | |||
| 1862 | 1862 | ||
| 1863 | DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0, | 1863 | DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0, |
| 1864 | doc: /* Perform completion on buffer names. | 1864 | doc: /* Perform completion on buffer names. |
| 1865 | If the argument FLAG is nil, invoke `try-completion', if it's t, invoke | 1865 | STRING and PREDICATE have the same meanings as in `try-completion', |
| 1866 | `all-completions', otherwise invoke `test-completion'. | 1866 | `all-completions', and `test-completion'. |
| 1867 | 1867 | ||
| 1868 | The arguments STRING and PREDICATE are as in `try-completion', | 1868 | If FLAG is nil, invoke `try-completion'; if it is t, invoke |
| 1869 | `all-completions', and `test-completion'. */) | 1869 | `all-completions'; otherwise invoke `test-completion'. */) |
| 1870 | (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag) | 1870 | (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag) |
| 1871 | { | 1871 | { |
| 1872 | if (NILP (flag)) | 1872 | if (NILP (flag)) |
diff --git a/src/search.c b/src/search.c index 1735ade5d8a..5224556fa17 100644 --- a/src/search.c +++ b/src/search.c | |||
| @@ -2220,15 +2220,14 @@ DEFUN ("replace-match", Freplace_match, Sreplace_match, 1, 5, 0, | |||
| 2220 | doc: /* Replace text matched by last search with NEWTEXT. | 2220 | doc: /* Replace text matched by last search with NEWTEXT. |
| 2221 | Leave point at the end of the replacement text. | 2221 | Leave point at the end of the replacement text. |
| 2222 | 2222 | ||
| 2223 | If second arg FIXEDCASE is non-nil, do not alter case of replacement text. | 2223 | If optional second arg FIXEDCASE is non-nil, do not alter the case of |
| 2224 | Otherwise maybe capitalize the whole text, or maybe just word initials, | 2224 | the replacement text. Otherwise, maybe capitalize the whole text, or |
| 2225 | based on the replaced text. | 2225 | maybe just word initials, based on the replaced text. If the replaced |
| 2226 | If the replaced text has only capital letters | 2226 | text has only capital letters and has at least one multiletter word, |
| 2227 | and has at least one multiletter word, convert NEWTEXT to all caps. | 2227 | convert NEWTEXT to all caps. Otherwise if all words are capitalized |
| 2228 | Otherwise if all words are capitalized in the replaced text, | 2228 | in the replaced text, capitalize each word in NEWTEXT. |
| 2229 | capitalize each word in NEWTEXT. | 2229 | |
| 2230 | 2230 | If optional third arg LITERAL is non-nil, insert NEWTEXT literally. | |
| 2231 | If third arg LITERAL is non-nil, insert NEWTEXT literally. | ||
| 2232 | Otherwise treat `\\' as special: | 2231 | Otherwise treat `\\' as special: |
| 2233 | `\\&' in NEWTEXT means substitute original matched text. | 2232 | `\\&' in NEWTEXT means substitute original matched text. |
| 2234 | `\\N' means substitute what matched the Nth `\\(...\\)'. | 2233 | `\\N' means substitute what matched the Nth `\\(...\\)'. |
| @@ -2239,13 +2238,11 @@ Otherwise treat `\\' as special: | |||
| 2239 | Any other character following `\\' signals an error. | 2238 | Any other character following `\\' signals an error. |
| 2240 | Case conversion does not apply to these substitutions. | 2239 | Case conversion does not apply to these substitutions. |
| 2241 | 2240 | ||
| 2242 | FIXEDCASE and LITERAL are optional arguments. | 2241 | If optional fourth argument STRING is non-nil, it should be a string |
| 2243 | 2242 | to act on; this should be the string on which the previous match was | |
| 2244 | The optional fourth argument STRING can be a string to modify. | 2243 | done via `string-match'. In this case, `replace-match' creates and |
| 2245 | This is meaningful when the previous match was done against STRING, | 2244 | returns a new string, made by copying STRING and replacing the part of |
| 2246 | using `string-match'. When used this way, `replace-match' | 2245 | STRING that was matched (the original STRING itself is not altered). |
| 2247 | creates and returns a new string made by copying STRING and replacing | ||
| 2248 | the part of STRING that was matched. | ||
| 2249 | 2246 | ||
| 2250 | The optional fifth argument SUBEXP specifies a subexpression; | 2247 | The optional fifth argument SUBEXP specifies a subexpression; |
| 2251 | it says to replace just that subexpression with NEWTEXT, | 2248 | it says to replace just that subexpression with NEWTEXT, |