diff options
| author | Paul Eggert | 2016-05-03 08:02:16 -0700 |
|---|---|---|
| committer | Paul Eggert | 2016-05-03 08:03:04 -0700 |
| commit | 2ea2a2f1a5b5b2e1b20f1ee8c86058334d0a2652 (patch) | |
| tree | 0a7120c29c00676f6e8f3599227c2ecfc37b5e26 /src | |
| parent | 8544b9879c652e7c700652a4ba6fd17245163bd4 (diff) | |
| download | emacs-2ea2a2f1a5b5b2e1b20f1ee8c86058334d0a2652.tar.gz emacs-2ea2a2f1a5b5b2e1b20f1ee8c86058334d0a2652.zip | |
Doc fixes for quoting
* doc/emacs/text.texi, doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/control.texi, doc/lispref/display.texi:
* doc/lispref/help.texi, doc/lispref/strings.texi, lisp/subr.el:
* src/callint.c, src/doprnt.c, src/editfns.c:
Document quoting a bit more systematically.
Problem reported by Alan Mackenzie (Bug#23425).
Diffstat (limited to 'src')
| -rw-r--r-- | src/callint.c | 2 | ||||
| -rw-r--r-- | src/doprnt.c | 6 | ||||
| -rw-r--r-- | src/editfns.c | 13 |
3 files changed, 12 insertions, 9 deletions
diff --git a/src/callint.c b/src/callint.c index e56f7cd1b84..053ee6cdaa5 100644 --- a/src/callint.c +++ b/src/callint.c | |||
| @@ -272,7 +272,7 @@ invoke it. If KEYS is omitted or nil, the return value of | |||
| 272 | { | 272 | { |
| 273 | /* `args' will contain the array of arguments to pass to the function. | 273 | /* `args' will contain the array of arguments to pass to the function. |
| 274 | `visargs' will contain the same list but in a nicer form, so that if we | 274 | `visargs' will contain the same list but in a nicer form, so that if we |
| 275 | pass it to `Fformat' it will be understandable to a human. */ | 275 | pass it to `Fformat_message' it will be understandable to a human. */ |
| 276 | Lisp_Object *args, *visargs; | 276 | Lisp_Object *args, *visargs; |
| 277 | Lisp_Object specs; | 277 | Lisp_Object specs; |
| 278 | Lisp_Object filter_specs; | 278 | Lisp_Object filter_specs; |
diff --git a/src/doprnt.c b/src/doprnt.c index 506bbc3df35..9d8b783565f 100644 --- a/src/doprnt.c +++ b/src/doprnt.c | |||
| @@ -46,15 +46,15 @@ along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ | |||
| 46 | ignored %s and %c conversions. (See below for the detailed documentation of | 46 | ignored %s and %c conversions. (See below for the detailed documentation of |
| 47 | what is supported.) However, this is okay, as this function is supposed to | 47 | what is supported.) However, this is okay, as this function is supposed to |
| 48 | be called from `error' and similar functions, and thus does not need to | 48 | be called from `error' and similar functions, and thus does not need to |
| 49 | support features beyond those in `Fformat', which is used by `error' on the | 49 | support features beyond those in `Fformat_message', which is used |
| 50 | Lisp level. */ | 50 | by `error' on the Lisp level. */ |
| 51 | 51 | ||
| 52 | /* In the FORMAT argument this function supports ` and ' as directives | 52 | /* In the FORMAT argument this function supports ` and ' as directives |
| 53 | that output left and right quotes as per ‘text-quoting style’. It | 53 | that output left and right quotes as per ‘text-quoting style’. It |
| 54 | also supports the following %-sequences: | 54 | also supports the following %-sequences: |
| 55 | 55 | ||
| 56 | %s means print a string argument. | 56 | %s means print a string argument. |
| 57 | %S is silently treated as %s, for loose compatibility with `Fformat'. | 57 | %S is treated as %s, for loose compatibility with `Fformat_message'. |
| 58 | %d means print a `signed int' argument in decimal. | 58 | %d means print a `signed int' argument in decimal. |
| 59 | %o means print an `unsigned int' argument in octal. | 59 | %o means print an `unsigned int' argument in octal. |
| 60 | %x means print an `unsigned int' argument in hex. | 60 | %x means print an `unsigned int' argument in hex. |
diff --git a/src/editfns.c b/src/editfns.c index f0ce4e7cf34..a858e6e79dd 100644 --- a/src/editfns.c +++ b/src/editfns.c | |||
| @@ -3665,10 +3665,11 @@ In batch mode, the message is printed to the standard error stream, | |||
| 3665 | followed by a newline. | 3665 | followed by a newline. |
| 3666 | 3666 | ||
| 3667 | The first argument is a format control string, and the rest are data | 3667 | The first argument is a format control string, and the rest are data |
| 3668 | to be formatted under control of the string. See `format' for details. | 3668 | to be formatted under control of the string. See `format-message' for |
| 3669 | details. | ||
| 3669 | 3670 | ||
| 3670 | Note: Use (message "%s" VALUE) to print the value of expressions and | 3671 | Note: (message "%s" VALUE) displays the string VALUE without |
| 3671 | variables to avoid accidentally interpreting `%' as format specifiers. | 3672 | interpreting format characters like `%', `\\=`', and `\\=''. |
| 3672 | 3673 | ||
| 3673 | If the first argument is nil or the empty string, the function clears | 3674 | If the first argument is nil or the empty string, the function clears |
| 3674 | any existing message; this lets the minibuffer contents show. See | 3675 | any existing message; this lets the minibuffer contents show. See |
| @@ -3696,7 +3697,8 @@ DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0, | |||
| 3696 | doc: /* Display a message, in a dialog box if possible. | 3697 | doc: /* Display a message, in a dialog box if possible. |
| 3697 | If a dialog box is not available, use the echo area. | 3698 | If a dialog box is not available, use the echo area. |
| 3698 | The first argument is a format control string, and the rest are data | 3699 | The first argument is a format control string, and the rest are data |
| 3699 | to be formatted under control of the string. See `format' for details. | 3700 | to be formatted under control of the string. See `format-message' for |
| 3701 | details. | ||
| 3700 | 3702 | ||
| 3701 | If the first argument is nil or the empty string, clear any existing | 3703 | If the first argument is nil or the empty string, clear any existing |
| 3702 | message; let the minibuffer contents show. | 3704 | message; let the minibuffer contents show. |
| @@ -3727,7 +3729,8 @@ If this command was invoked with the mouse, use a dialog box if | |||
| 3727 | `use-dialog-box' is non-nil. | 3729 | `use-dialog-box' is non-nil. |
| 3728 | Otherwise, use the echo area. | 3730 | Otherwise, use the echo area. |
| 3729 | The first argument is a format control string, and the rest are data | 3731 | The first argument is a format control string, and the rest are data |
| 3730 | to be formatted under control of the string. See `format' for details. | 3732 | to be formatted under control of the string. See `format-message' for |
| 3733 | details. | ||
| 3731 | 3734 | ||
| 3732 | If the first argument is nil or the empty string, clear any existing | 3735 | If the first argument is nil or the empty string, clear any existing |
| 3733 | message; let the minibuffer contents show. | 3736 | message; let the minibuffer contents show. |