Skip to content

Commit 16eed7c

Browse files
committed
Merge branch 'mh/fetch-filter-refs'
Finishing touch to update documentation of string-list to make sure the earlier rewrite of ref-list match logic that depends on its sort order will not get broken. * mh/fetch-filter-refs: string_list API: document what "sorted" means
2 parents 36d1f3d + 1959bf6 commit 16eed7c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Documentation/technical/api-string-list.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
string-list API
22
===============
33

4-
The string_list API offers a data structure and functions to handle sorted
5-
and unsorted string lists.
4+
The string_list API offers a data structure and functions to handle
5+
sorted and unsorted string lists. A "sorted" list is one whose
6+
entries are sorted by string value in `strcmp()` order.
67

78
The 'string_list' struct used to be called 'path_list', but was renamed
89
because it is not specific to paths.
@@ -143,7 +144,7 @@ write `string_list_insert(...)->util = ...;`.
143144

144145
`sort_string_list`::
145146

146-
Make an unsorted list sorted.
147+
Sort the list's entries by string value in `strcmp()` order.
147148

148149
`unsorted_string_list_has_string`::
149150

0 commit comments

Comments
 (0)