mirror of
https://github.com/git/git
synced 2024-08-24 18:26:02 +00:00
Merge branch 'jc/hashmap-doc-init' into maint
The API documentation for hashmap was unclear if hashmap_entry can be safely discarded without any other consideration. State that it is safe to do so. * jc/hashmap-doc-init: hashmap: clarify that hashmap_entry can safely be discarded
This commit is contained in:
commit
33481c1e59
|
@ -104,6 +104,11 @@ If `free_entries` is true, each hashmap_entry in the map is freed as well
|
|||
`entry` points to the entry to initialize.
|
||||
+
|
||||
`hash` is the hash code of the entry.
|
||||
+
|
||||
The hashmap_entry structure does not hold references to external resources,
|
||||
and it is safe to just discard it once you are done with it (i.e. if
|
||||
your structure was allocated with xmalloc(), you can just free(3) it,
|
||||
and if it is on stack, you can just let it go out of scope).
|
||||
|
||||
`void *hashmap_get(const struct hashmap *map, const void *key, const void *keydata)`::
|
||||
|
||||
|
|
Loading…
Reference in a new issue