diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2012-09-21 11:17:00 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-09-21 11:17:00 -0700 |
| commit | 16eed7c9938a65022010c3d95ada911b2fd46d25 (patch) | |
| tree | fe0e45fd2f6d493c860b1d5b032dc6dd08380c7c | |
| parent | Merge branch 'jc/maint-log-grep-all-match-1' (diff) | |
| parent | string_list API: document what "sorted" means (diff) | |
| download | tgif-16eed7c9938a65022010c3d95ada911b2fd46d25.tar.xz | |
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
| -rw-r--r-- | Documentation/technical/api-string-list.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/technical/api-string-list.txt b/Documentation/technical/api-string-list.txt index 155ac8cb10..94d7a2bd99 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`:: |