diff options
| author | Joel E. Denny <jdenny@clemson.edu> | 2009-08-22 20:55:17 -0400 |
|---|---|---|
| committer | Joel E. Denny <jdenny@clemson.edu> | 2009-08-23 18:30:34 -0400 |
| commit | 98bf7f3d50bbdf7f043938f754c50c7e467933bf (patch) | |
| tree | 6ab15429ee09114d297ee0657f2de4bff75b15c7 /lib/quotearg.h | |
| parent | 12247f770487cd389e515a51d6bfeb250f26e519 (diff) | |
| download | gnulib-98bf7f3d50bbdf7f043938f754c50c7e467933bf.tar.gz | |
quotearg: document limitations of quote_these_too
* lib/quotearg.c (quotearg_buffer_restyled): Add comments where
those limitations are created.
* lib/quotearg.h (set_char_quoting): Document that digits and
letters that are special after backslash are not permitted.
(quotearg_char): Cross-reference set_char_quoting documentation.
Diffstat (limited to 'lib/quotearg.h')
| -rw-r--r-- | lib/quotearg.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/quotearg.h b/lib/quotearg.h index e9f6f56a34..63c47f13cc 100644 --- a/lib/quotearg.h +++ b/lib/quotearg.h @@ -255,7 +255,9 @@ void set_quoting_style (struct quoting_options *o, enum quoting_style s); set the value of the quoting options for character C to I. Return the old value. Currently, the only values defined for I are 0 (the default) and 1 (which means to quote the character even if - it would not otherwise be quoted). */ + it would not otherwise be quoted). C must never be a digit or a + letter that has special meaning after a backslash (for example, "\t" + for tab). */ int set_char_quoting (struct quoting_options *o, char c, int i); /* In O (or in the default if O is null), @@ -345,7 +347,8 @@ char *quotearg_style (enum quoting_style s, char const *arg); char *quotearg_style_mem (enum quoting_style s, char const *arg, size_t argsize); -/* Like quotearg (ARG), except also quote any instances of CH. */ +/* Like quotearg (ARG), except also quote any instances of CH. + See set_char_quoting for a description of acceptable CH values. */ char *quotearg_char (char const *arg, char ch); /* Like quotearg_char (ARG, CH), except it can quote null bytes. */ |