From 3c73e30e34593dbd43ac6bdd8b6cdf70f493e3a2 Mon Sep 17 00:00:00 2001
From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 11 Dec 2010 11:41:45 +0200
Subject: [PATCH] Fix bug #7563 with docs of split-string-and-unquote.
processes.texi (Shell Arguments): Fix documentation of
`split-string-and-unquote'. Add indexing.
---
doc/lispref/ChangeLog | 5 +++++
doc/lispref/processes.texi | 13 ++++++++++---
2 files changed, 15 insertions(+), 3 deletions(-)
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index b27efdda941..50c23da7027 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2010-12-11 Eli Zaretskii <eliz@gnu.org>
+
+ * processes.texi (Shell Arguments): Fix documentation of
+ `split-string-and-unquote'. Add indexing. (Bug#7563)
+
2010-12-07 Stefan Monnier <monnier@iro.umontreal.ca>
* modes.texi (Auto-Indentation): New section to document SMIE.
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi
index 1a4a766c81c..e281c0d5917 100644
--- a/doc/lispref/processes.texi
+++ b/doc/lispref/processes.texi
@@ -195,10 +195,17 @@ a shell command:
@end example
@end defun
-@cindex quoting and unquoting shell command line
+@cindex quoting and unquoting command-line arguments
+@cindex minibuffer input, and command-line arguments
+@cindex @code{call-process}, command-line arguments from minibuffer
+@cindex @code{start-process}, command-line arguments from minibuffer
The following two functions are useful for creating shell commands
from individual argument strings, and taking shell command lines apart
-into individual arguments.
+into individual arguments. These functions are mainly intended to be
+used for converting user input in the minibuffer, a Lisp string, into
+a list of string arguments to be passed to @code{call-process} or
+@code{start-process}, or for the converting such lists of arguments in
+a single Lisp string to be presented in the minibuffer or echo area.
@defun split-string-and-unquote string &optional separators
This function splits @var{string} into substrings at matches for the
@@ -210,7 +217,7 @@ If @var{separators} is omitted or @code{nil}, it defaults to
@code{"\\s-+"}, which is a regular expression that matches one or more
characters with whitespace syntax (@pxref{Syntax Class Table}).
-This function performs two types of quoting: enclosing a whole string
+This function supports two types of quoting: enclosing a whole string
in double quotes @code{"@dots{}"}, and quoting individual characters
with a backslash escape @samp{\}. The latter is also used in Lisp
strings, so this function can handle those as well.
--
2.39.5