• J
    hashmap: clarify that hashmap_entry can safely be discarded · 54ba5a1a
    Junio C Hamano 提交于
    The API documentation said that the hashmap_entry structure to be
    embedded in the caller's structure is to be treated as opaque, which
    left the reader wondering if it can safely be discarded when it no
    longer is necessary.  If the hashmap_entry structure had references
    to external resources such as allocated memory or an open file
    descriptor, merely free(3)ing the containing structure (when the
    caller's structure is on the heap) or letting it go out of scope
    (when it is on the stack) would end up leaking the external
    resource.
    
    Document that there is no need for hashmap_entry_clear() that
    corresponds to hashmap_entry_init() to give the API users a little
    bit of peace of mind.
    Signed-off-by: NJunio C Hamano <gitster@pobox.com>
    54ba5a1a
api-hashmap.txt 9.3 KB