summaryrefslogtreecommitdiff
path: root/Documentation/technical
diff options
context:
space:
mode:
authorTanay Abhra <tanayabh@gmail.com>2014-06-03 09:13:18 (GMT)
committerJunio C Hamano <gitster@pobox.com>2014-06-06 20:49:19 (GMT)
commitacb3d22264fd3736f95f71aa38e1d6fa01f5e9e1 (patch)
tree0917dd95d20ff60df790ac5c2e53ee37838bad53 /Documentation/technical
parente156455ea49124c140a67623f22a393db62d5d98 (diff)
downloadgit-acb3d22264fd3736f95f71aa38e1d6fa01f5e9e1.zip
git-acb3d22264fd3736f95f71aa38e1d6fa01f5e9e1.tar.gz
git-acb3d22264fd3736f95f71aa38e1d6fa01f5e9e1.tar.bz2
string-list: spell all values out that are given to a string_list initializer
STRING_LIST_INIT_{NODUP,DUP} initializers list values only for earlier structure members, relying on the usual convention in C that the omitted members are initailized to 0, i.e. the former is expanded to the latter: struct string_list l = STRING_LIST_INIT_DUP; struct string_list l = { NULL, 0, 0, 1 }; and the last member that is not mentioned (i.e. 'cmp') is initialized to NULL. While there is nothing wrong in this construct, spelling out all the values where the macros are defined will serve also as a documentation, so let's do so. Signed-off-by: Tanay Abhra <tanayabh@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical')
-rw-r--r--Documentation/technical/api-string-list.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/technical/api-string-list.txt b/Documentation/technical/api-string-list.txt
index 20be348..f1add51 100644
--- a/Documentation/technical/api-string-list.txt
+++ b/Documentation/technical/api-string-list.txt
@@ -200,3 +200,5 @@ Represents the list itself.
You should not tamper with it.
. Setting the `strdup_strings` member to 1 will strdup() the strings
before adding them, see above.
+. The `compare_strings_fn` member is used to specify a custom compare
+ function, otherwise `strcmp()` is used as the default function.