[PATCH 2/2] Document the string_list structure

[Han-Wen Nienhuys <hanwen@google.com>]

Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
---
 string-list.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/string-list.h b/string-list.h
index 29bfb7ae4..08b534166 100644
--- a/string-list.h
+++ b/string-list.h
@@ -8,6 +8,12 @@ struct string_list_item {
 
 typedef int (*compare_strings_fn)(const char *, const char *);
 
+/* A resizable array of strings. The strings are owned if
+ * 'strdup_strings' is set. It can be used as a sorted array, and a
+ * custom comparison may be given in 'cmp'. The field 'items[i].util'
+ * may be used to implement an array of pairs. In that case, the
+ * caller is responsible for managing memory pointed to by 'util'.
+ */
 struct string_list {
 	struct string_list_item *items;
 	unsigned int nr, alloc;
-- 
2.14.1.821.g8fa685d3b7-goog