]> code.delx.au - gnu-emacs/commitdiff
Fix doc string of 'shell-quote-argument'
authorEli Zaretskii <eliz@gnu.org>
Sun, 18 Oct 2015 17:08:32 +0000 (20:08 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sun, 18 Oct 2015 17:08:32 +0000 (20:08 +0300)
* lisp/subr.el (shell-quote-argument): Doc fix.  (Bug#21702)

lisp/subr.el

index e1769074ee5edc553ccaaa8291e46b1b44eae863..c903ee3c7585f9114b9ff8266aa6c9b27c59871f 100644 (file)
@@ -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