mirror of
https://github.com/git/git.git
synced 2024-05-10 01:26:31 +02:00
commit-slab: clarify slabname##_peek()'s return value
Ever since 862e730ec1
(commit-slab: introduce slabname##_peek()
function, 2015-05-14) the slabname##_peek() function is documented as:
This function is similar to indegree_at(), but it will return NULL
until a call to indegree_at() was made for the commit.
This, however, is usually not the case. If indegree_at() allocates
memory, then it will do so not only for the single commit it got as
parameter, but it will allocate a whole new, ~512kB slab. Later on,
if any other commit's 'index' field happens to point into an already
allocated slab, then indegree_peek() for such a commit will return a
valid non-NULL pointer, pointing to a zero-initialized location in the
slab, even if no indegree_at() call has been made for that commit yet.
Update slabname##_peek()'s documentation to clarify this.
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
4cd1cf31ef
commit
7422b2a0a1
|
@ -24,7 +24,12 @@
|
||||||
* - int *indegree_peek(struct indegree *, struct commit *);
|
* - int *indegree_peek(struct indegree *, struct commit *);
|
||||||
*
|
*
|
||||||
* This function is similar to indegree_at(), but it will return NULL
|
* This function is similar to indegree_at(), but it will return NULL
|
||||||
* until a call to indegree_at() was made for the commit.
|
* if the location to store the data associated with the given commit
|
||||||
|
* has not been allocated yet.
|
||||||
|
* Note that the location to store the data might have already been
|
||||||
|
* allocated even if no indegree_at() call has been made for that commit
|
||||||
|
* yet; in this case this function returns a pointer to a
|
||||||
|
* zero-initialized location.
|
||||||
*
|
*
|
||||||
* - void init_indegree(struct indegree *);
|
* - void init_indegree(struct indegree *);
|
||||||
* void init_indegree_with_stride(struct indegree *, int);
|
* void init_indegree_with_stride(struct indegree *, int);
|
||||||
|
|
Loading…
Reference in New Issue