summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-string-list.txt
diff options
context:
space:
mode:
authorMichael Haggerty <mhagger@alum.mit.edu>2012-09-17 15:21:07 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-09-18 18:41:06 (GMT)
commit1959bf6430fda685c46241f220f521a01f9469b7 (patch)
tree02e24eb8425d29c7501d8bddcd386501d19beb6b /Documentation/technical/api-string-list.txt
parent65119878548f869270fbc8d382f042cca3a6ad05 (diff)
downloadgit-1959bf6430fda685c46241f220f521a01f9469b7.zip
git-1959bf6430fda685c46241f220f521a01f9469b7.tar.gz
git-1959bf6430fda685c46241f220f521a01f9469b7.tar.bz2
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 <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-string-list.txt')
-rw-r--r--Documentation/technical/api-string-list.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/technical/api-string-list.txt b/Documentation/technical/api-string-list.txt
index 155ac8c..94d7a2b 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`::