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

Merge branch 'mh/fetch-filter-refs'

Browse Source 
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
This commit is contained in:
Junio C Hamano 2012-09-21 11:17:00 -07:00
commit 16eed7c993
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`::