changeset 16849:1aa668619908

system-quote: Add more comments. * lib/system-quote.h: Add more comments about wilcards and limitations. Suggested by Eli Zaretskii <eliz@gnu.org>.
author Bruno Haible <bruno@clisp.org>
date Sat, 12 May 2012 22:49:04 +0200
parents ae444fc80840
children f87aab0c02ac
files ChangeLog lib/system-quote.h
diffstat 2 files changed, 20 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2012-05-12  Bruno Haible  <bruno@clisp.org>
 
+	system-quote: Add more comments.
+	* lib/system-quote.h: Add more comments about wilcards and limitations.
+	Suggested by Eli Zaretskii <eliz@gnu.org>.
+
 	sh-quote, system-quote: Add comments about wildcards.
 	* lib/sh-quote.h: Clarify what happens with wildcard characters.
 	* lib/system-quote.h: Likewise.
--- a/lib/system-quote.h
+++ b/lib/system-quote.h
@@ -29,7 +29,22 @@
        contain newlines or carriage return characters to programs through
        cmd.exe.
      - Windows programs usually perform wildcard expansion when they receive
-       arguments that contain unquoted '*', '?' characters.  */
+       arguments that contain unquoted '*', '?' characters.
+
+  With this module, you can build a command that will invoke a program with
+  specific strings as arguments.
+
+  Note: If you want wildcard expansion to happen, you have to first do wildcard
+  expansion through the 'glob' module, then quote the resulting strings through
+  this module, and then invoke the system's command interpreter.
+
+  Limitations:
+    - When invoking native Windows programs on Windows Vista or newer,
+      wildcard expansion will occur in the invoked program nevertheless.
+    - On native Windows, for SCI_SYSTEM and SCI_WINDOWS_CMD, newlines and
+      carriage return characters are not supported.  Their undesired effect
+      is to truncate the entire command line.
+ */
 
 #include <stddef.h>