quote.h: fix bogus comment
authorJeff King <peff@peff.net>
Tue, 13 Sep 2011 21:57:47 +0000 (17:57 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 14 Sep 2011 18:44:05 +0000 (11:44 -0700)
Commit 758e915 made sq_quote_next static, removing it from
quote.h. However, it forgot to update the related comment,
making it appear as a confusing description of sq_quote_to_argv.

Let's remove the crufty bits, and elaborate more on sq_quote_to_argv.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
quote.h

diff --git a/quote.h b/quote.h
index 024e21d80ceaa37ec1f893acc907a62092560d21..252b0df4b289d4955eaad42d61af33a07c814fd9 100644 (file)
--- a/quote.h
+++ b/quote.h
@@ -40,9 +40,8 @@ extern char *sq_dequote(char *);
 
 /*
  * Same as the above, but can be used to unwrap many arguments in the
- * same string separated by space. "next" is changed to point to the
- * next argument that should be passed as first parameter. When there
- * is no more argument to be dequoted, "next" is updated to point to NULL.
+ * same string separated by space. Like sq_quote, it works in place,
+ * modifying arg and appending pointers into it to argv.
  */
 extern int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);