[Bug-gnulib] quotearg styles

[Bruno Haible]

Hi,

Users of the quotearg module should know what each quoting style does.
Since the quotearg module doesn't have a documentation of its own, I propose
to document it through comments in the .h file.

Bruno

*** quotearg.h  Mon Nov 25 14:09:14 2002
--- quotearg.h.new      Thu Feb  5 12:07:54 2004
***************
*** 27,39 ****
--- 27,64 ----
  /* Basic quoting styles.  */
  enum quoting_style
    {
+ 
      literal_quoting_style,    /* --quoting-style=literal */
+                               /* Produces the arg unchanged.  */
+ 
      shell_quoting_style,      /* --quoting-style=shell */
+                               /* Adds single quotes if needed, so that
+                                  evaluation by an sh compatible shell
+                                  produces the given arg.  */
+ 
      shell_always_quoting_style,       /* --quoting-style=shell-always */
+                               /* Adds single quotes, so that evaluation
+                                  by an sh compatible shell produces the
+                                  given arg.  */
+ 
      c_quoting_style,          /* --quoting-style=c */
+                               /* Adds double quotes and backslashes, so that
+                                  compilation by a C or C++ compiler produces
+                                  a string literal equal to the given arg.  */
+ 
      escape_quoting_style,     /* --quoting-style=escape */
+                               /* Adds backslashes for unprintable
+                                  characters.  */
+ 
      locale_quoting_style,     /* --quoting-style=locale */
+                               /* Adds locale dependent quotation marks,
+                                  falling back to `...' style. Also adds
+                                  backslashes for unprintable characters.  */
+ 
      clocale_quoting_style     /* --quoting-style=clocale */
+                               /* Adds locale dependent quotation marks,
+                                  falling back to "..." style. Also adds
+                                  backslashes for unprintable characters.  */
    };
  
  /* For now, --quoting-style=literal is the default, but this may change.  */