aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorXue Fuqiao2013-12-23 15:55:08 +0800
committerXue Fuqiao2013-12-23 15:55:08 +0800
commit46291d111fe5c915099ab38cc54b07ebc82bcea0 (patch)
tree8276a069562c5b126c14870da639b5435ef05070 /doc
parent7510b0219cb36b49032393c5295f14efd0c8df2f (diff)
downloademacs-46291d111fe5c915099ab38cc54b07ebc82bcea0.tar.gz
emacs-46291d111fe5c915099ab38cc54b07ebc82bcea0.zip
Document TRIM in `split-string'.
* doc/lispref/strings.texi (Creating Strings): Document TRIM in `split-string'.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/strings.texi7
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index aae5a1a6cc2..c598cf0f5aa 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12013-12-23 Xue Fuqiao <xfq.free@gmail.com>
2
3 * strings.texi (Creating Strings): Document TRIM in `split-string'.
4
12013-12-23 Chong Yidong <cyd@gnu.org> 52013-12-23 Chong Yidong <cyd@gnu.org>
2 6
3 * keymaps.texi (Controlling Active Maps): Renamed 7 * keymaps.texi (Controlling Active Maps): Renamed
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi
index 340115062f9..0fe319d97fb 100644
--- a/doc/lispref/strings.texi
+++ b/doc/lispref/strings.texi
@@ -268,7 +268,7 @@ string to be used as a shell command, see @ref{Shell Arguments,
268combine-and-quote-strings}. 268combine-and-quote-strings}.
269@end defun 269@end defun
270 270
271@defun split-string string &optional separators omit-nulls 271@defun split-string string &optional separators omit-nulls trim
272This function splits @var{string} into substrings based on the regular 272This function splits @var{string} into substrings based on the regular
273expression @var{separators} (@pxref{Regular Expressions}). Each match 273expression @var{separators} (@pxref{Regular Expressions}). Each match
274for @var{separators} defines a splitting point; the substrings between 274for @var{separators} defines a splitting point; the substrings between
@@ -350,6 +350,11 @@ practice:
350 @result{} ("o" "o" "o") 350 @result{} ("o" "o" "o")
351@end example 351@end example
352 352
353If the optional argument @var{trim} is non-@code{nil}, it should be a
354regular expression to match text to trim from the beginning and end of
355each substring. If trimming makes the substring empty, it is treated
356as null.
357
353If you need to split a string into a list of individual command-line 358If you need to split a string into a list of individual command-line
354arguments suitable for @code{call-process} or @code{start-process}, 359arguments suitable for @code{call-process} or @code{start-process},
355see @ref{Shell Arguments, split-string-and-unquote}. 360see @ref{Shell Arguments, split-string-and-unquote}.