Skip to content

Commit

Permalink
Merge branch 'en/string-list-can-be-custom-sorted' into maint
Browse files Browse the repository at this point in the history
API-doc update.

* en/string-list-can-be-custom-sorted:
  string-list: note in docs that callers can specify sorting function
  • Loading branch information
gitster committed Feb 14, 2020
2 parents 9eddeae + 065027e commit d0ebd64
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions string-list.h
Expand Up @@ -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:
*
Expand Down Expand Up @@ -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);

Expand Down

0 comments on commit d0ebd64

Please sign in to comment.