diff options
| author | Junio C Hamano <gitster@pobox.com> | 2020-03-25 13:57:42 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-03-25 13:57:42 -0700 |
| commit | 38afd2d1ad8afc59e3bed02b8c4be2080e8e5150 (patch) | |
| tree | a2bd33860ca36cc002114512478125327495e2a7 | |
| parent | Merge branch 'jc/maintain-doc' (diff) | |
| parent | commit-slab: clarify slabname##_peek()'s return value (diff) | |
| download | git-38afd2d1ad8afc59e3bed02b8c4be2080e8e5150.tar.gz git-38afd2d1ad8afc59e3bed02b8c4be2080e8e5150.zip | |
Merge branch 'sg/commit-slab-clarify-peek'
In-code comment update.
* sg/commit-slab-clarify-peek:
commit-slab: clarify slabname##_peek()'s return value
| -rw-r--r-- | commit-slab.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/commit-slab.h b/commit-slab.h index 69bf0c807c..05b3f2804e 100644 --- a/commit-slab.h +++ b/commit-slab.h @@ -24,7 +24,12 @@ * - int *indegree_peek(struct indegree *, struct commit *); * * 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_with_stride(struct indegree *, int); |