[glib] docs: Fill in gshell long description



commit 06b7786f31a6038e78bcc99c88c076e8f9ff07f0
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat May 31 10:18:07 2014 -0400

    docs: Fill in gshell long description

 glib/gshell.c |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)
---
diff --git a/glib/gshell.c b/glib/gshell.c
index 1c39c33..596f081 100644
--- a/glib/gshell.c
+++ b/glib/gshell.c
@@ -37,7 +37,15 @@
  * SECTION:shell
  * @title: Shell-related Utilities
  * @short_description: shell-like commandline handling
- **/
+ *
+ * GLib provides the functions g_shell_quote() and g_shell_unquote()
+ * to handle shell-like quoting in strings. The function g_shell_parse_argv()
+ * parses a string similar to the way a POSIX shell (/bin/sh) would.
+ *
+ * Note that string handling in shells has many obscure and historical
+ * corner-cases which these functions do not necessarily reproduce. They
+ * are good enough in practice, though.
+ */
 
 /**
  * G_SHELL_ERROR:


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]