From: Michael Haggerty Date: Mon, 17 Sep 2012 15:21:07 +0000 (+0200) Subject: string_list API: document what "sorted" means X-Git-Tag: v1.8.0-rc0~30^2 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=1959bf6430fda685c46241f220f521a01f9469b7;p=git.git string_list API: document what "sorted" means The recent work on using string_list to represent the list of refs that matched with the refs on the other side during fetch heavily depends on the sort order by string_list's implementation, and changing string_list will break it. Document that it uses strcmp() order, at least for now. Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano --- diff --git a/Documentation/technical/api-string-list.txt b/Documentation/technical/api-string-list.txt index 155ac8cb1..94d7a2bd9 100644 --- a/Documentation/technical/api-string-list.txt +++ b/Documentation/technical/api-string-list.txt @@ -1,8 +1,9 @@ string-list API =============== -The string_list API offers a data structure and functions to handle sorted -and unsorted string lists. +The string_list API offers a data structure and functions to handle +sorted and unsorted string lists. A "sorted" list is one whose +entries are sorted by string value in `strcmp()` order. The 'string_list' struct used to be called 'path_list', but was renamed because it is not specific to paths. @@ -143,7 +144,7 @@ write `string_list_insert(...)->util = ...;`. `sort_string_list`:: - Make an unsorted list sorted. + Sort the list's entries by string value in `strcmp()` order. `unsorted_string_list_has_string`::