Document TRIM in `split-string'.

* doc/lispref/strings.texi (Creating Strings): Document TRIM in
`split-string'.
This commit is contained in:
Xue Fuqiao 2013-12-23 15:55:08 +08:00
parent 7510b0219c
commit 46291d111f
3 changed files with 11 additions and 1 deletions

View file

@ -1,3 +1,7 @@
2013-12-23 Xue Fuqiao <xfq.free@gmail.com>
* strings.texi (Creating Strings): Document TRIM in `split-string'.
2013-12-23 Chong Yidong <cyd@gnu.org>
* keymaps.texi (Controlling Active Maps): Renamed

View file

@ -268,7 +268,7 @@ string to be used as a shell command, see @ref{Shell Arguments,
combine-and-quote-strings}.
@end defun
@defun split-string string &optional separators omit-nulls
@defun split-string string &optional separators omit-nulls trim
This function splits @var{string} into substrings based on the regular
expression @var{separators} (@pxref{Regular Expressions}). Each match
for @var{separators} defines a splitting point; the substrings between
@ -350,6 +350,11 @@ practice:
@result{} ("o" "o" "o")
@end example
If the optional argument @var{trim} is non-@code{nil}, it should be a
regular expression to match text to trim from the beginning and end of
each substring. If trimming makes the substring empty, it is treated
as null.
If you need to split a string into a list of individual command-line
arguments suitable for @code{call-process} or @code{start-process},
see @ref{Shell Arguments, split-string-and-unquote}.

View file

@ -983,6 +983,7 @@ The few hooks that used with-wrapper-hook are replaced as follows:
** `byte-compile-interactive-only-functions' is now obsolete.
It has been replaced by the symbol property 'interactive-only.
+++
** `split-string' now takes an optional argument TRIM.
The value, if non-nil, is a regexp that specifies what to trim from
the start and end of each substring.