undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

string_list API: document what "sorted" means

Browse Source 
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>
This commit is contained in:
Michael Haggerty 2012-09-17 17:21:07 +02:00 committed by Junio C Hamano
parent 6511987854
commit 1959bf6430
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/technical/api-string-list.txt
View File

@ -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`::