summaryrefslogtreecommitdiff
path: root/string-list.h
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-01-22 23:07:30 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-01-22 23:07:31 (GMT)
commit1f10b84e43cbcf50715b6effd858530e14626952 (patch)
tree8a489d61ef5a62a48e846b5ae5b0461c29766a73 /string-list.h
parenta3648c02a29183841a734b192aa9a6f887ce4817 (diff)
parent065027ee1a7b3ecc45b6d331983d38642835c451 (diff)
downloadgit-1f10b84e43cbcf50715b6effd858530e14626952.zip
git-1f10b84e43cbcf50715b6effd858530e14626952.tar.gz
git-1f10b84e43cbcf50715b6effd858530e14626952.tar.bz2
Merge branch 'en/string-list-can-be-custom-sorted'
API-doc update. * en/string-list-can-be-custom-sorted: string-list: note in docs that callers can specify sorting function
Diffstat (limited to 'string-list.h')
-rw-r--r--string-list.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/string-list.h b/string-list.h
index 7bb0ad0..6c5d274 100644
--- a/string-list.h
+++ b/string-list.h
@@ -4,7 +4,8 @@
/**
* The string_list API offers a data structure and functions to handle
* sorted and unsorted arrays of strings. A "sorted" list is one whose
- * entries are sorted by string value in `strcmp()` order.
+ * entries are sorted by string value in the order specified by the `cmp`
+ * member (`strcmp()` by default).
*
* The caller:
*
@@ -209,7 +210,8 @@ struct string_list_item *string_list_append(struct string_list *list, const char
struct string_list_item *string_list_append_nodup(struct string_list *list, char *string);
/**
- * Sort the list's entries by string value in `strcmp()` order.
+ * Sort the list's entries by string value in order specified by list->cmp
+ * (strcmp() if list->cmp is NULL).
*/
void string_list_sort(struct string_list *list);