diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2020-02-14 12:42:27 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-02-14 12:42:27 -0800 |
| commit | d0ebd645b191c4f46a9d9122d1f88d7549a32f45 (patch) | |
| tree | 86a20da1bbbef9c30534c288a4599bd77f44f3f9 | |
| parent | Merge branch 'jt/sha1-file-remove-oi-skip-cached' into maint (diff) | |
| parent | string-list: note in docs that callers can specify sorting function (diff) | |
| download | tgif-d0ebd645b191c4f46a9d9122d1f88d7549a32f45.tar.xz | |
Merge branch 'en/string-list-can-be-custom-sorted' into maint
API-doc update.
* en/string-list-can-be-custom-sorted:
string-list: note in docs that callers can specify sorting function
| -rw-r--r-- | string-list.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/string-list.h b/string-list.h index 7bb0ad07e6..6c5d274126 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); |