summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2015-10-18 20:08:32 +0300
committerEli Zaretskii <eliz@gnu.org>2015-10-18 20:08:32 +0300
commitb03150f6ebea1a49f7061a3caf184c6e7e6490c7 (patch)
tree9a74c5ab178ded8be77aecc2961985a937987aee
parent1106f317ab064264adbc07001bdc6940ad07f4d4 (diff)
downloademacs-b03150f6ebea1a49f7061a3caf184c6e7e6490c7.tar.gz
Fix doc string of 'shell-quote-argument'
* lisp/subr.el (shell-quote-argument): Doc fix. (Bug#21702)
-rw-r--r--lisp/subr.el5
1 files changed, 4 insertions, 1 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index e1769074ee5..c903ee3c758 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -2711,7 +2711,10 @@ Note: :data and :device are currently not supported on Windows."
(declare-function w32-shell-dos-semantics "w32-fns" nil)
(defun shell-quote-argument (argument)
- "Quote ARGUMENT for passing as argument to an inferior shell."
+ "Quote ARGUMENT for passing as argument to an inferior shell.
+
+This function is designed to work with the syntax of your system's
+standard shell, and might produce incorrect results with unusual shells."
(cond
((eq system-type 'ms-dos)
;; Quote using double quotes, but escape any existing quotes in