summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHeiko Voigt <hvoigt@hvoigt.net>2012-03-29 07:21:22 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-03-30 16:06:04 (GMT)
commitb8939b2b3abaa99c18bf57251cd2828b89ac38c5 (patch)
tree8af94e0a930a6887d6e1978b21f4872d6f395280
parent8ced9c90a28f6abc80dc5ad4cf7921c2322c0bb0 (diff)
downloadgit-b8939b2b3abaa99c18bf57251cd2828b89ac38c5.zip
git-b8939b2b3abaa99c18bf57251cd2828b89ac38c5.tar.gz
git-b8939b2b3abaa99c18bf57251cd2828b89ac38c5.tar.bz2
string-list: document that string_list_insert() inserts unique strings
Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/technical/api-string-list.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/technical/api-string-list.txt b/Documentation/technical/api-string-list.txt
index ce24eb9..5a0c14f 100644
--- a/Documentation/technical/api-string-list.txt
+++ b/Documentation/technical/api-string-list.txt
@@ -83,7 +83,9 @@ Functions
Insert a new element to the string_list. The returned pointer can be
handy if you want to write something to the `util` pointer of the
- string_list_item containing the just added string.
+ string_list_item containing the just added string. If the given
+ string already exists the insertion will be skipped and the
+ pointer to the existing item returned.
+
Since this function uses xrealloc() (which die()s if it fails) if the
list needs to grow, it is safe not to check the pointer. I.e. you may