mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-28 07:45:00 +00:00
Code Issues Releases Activity

(Formatting Strings): Warn against arbitrary strings as first arg to `format'.

Browse Source
This commit is contained in:
Eli Zaretskii 2006-08-04 10:42:41 +00:00
parent 6f64cebf16
commit 65c6c6b6ca
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lispref/ChangeLog
View File

@ -1,3 +1,8 @@
2006-08-04 Eli Zaretskii <eliz@gnu.org>
* strings.texi (Formatting Strings): Warn against arbitrary
strings as first arg to `format'.
2006-07-31 Thien-Thi Nguyen <ttn@gnu.org>
* text.texi (Clickable Text): Mention `help-echo' text property.

12
lispref/strings.texi
View File

@ -701,7 +701,6 @@ arguments @var{objects} are the computed values to be formatted.
The characters in @var{string}, other than the format specifications,
are copied directly into the output; if they have text properties,
these are copied into the output also.
@end defun
@cindex @samp{%} in format
@ -719,6 +718,17 @@ For example:
@end group
@end example
Since @code{format} interprets @samp{%} characters as format
specifications, you should @emph{never} pass an arbitrary string as
the first argument. This is particularly true when the string is
generated by some Lisp code. Unless the string is @emph{known} to
never include any @samp{%} characters, pass @code{"%s"}, described
below, as the first argument, and the string as the second, like this:
@example
(format "%s" @var{arbitrary-string})
@end example
If @var{string} contains more than one format specification, the
format specifications correspond to successive values from
@var{objects}. Thus, the first format specification in @var{string}