Thread (5 messages) flat view 5 messages, 3 authors, 2017-09-21
STALE3263d

[PATCH 2/2] Document the string_list structure

From: Han-Wen Nienhuys <hidden>
Date: 2017-09-21 12:44:28
Subsystem: the rest · Maintainer: Linus Torvalds

Signed-off-by: Han-Wen Nienhuys <redacted>
---
 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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help