mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sha1-array: move doc to sha1-array.h

Browse Source 
Move the documentation from Documentation/technical/api-oid-array.txt to
sha1-array.h as it's easier for the developers to find the usage
information beside the code instead of looking for it in another doc file.

Also documentation/technical/api-oid-array.txt is removed because the
information it has is now redundant and it'll be hard to keep it up to
date and synchronized with the documentation in the header file.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Heba Waly
2019-11-17 21:04:44 +00:00
committed by Junio C Hamano
parent d3d7172e40
commit 405c6b1fbc
3 changed files with 81 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
sha1-array.c
View File

@ -48,7 +48,7 @@ int oid_array_for_each(struct oid_array *array,
{
int i;
/* No oid_array_sort() here! See the api-oid-array.txt docs! */
/* No oid_array_sort() here! See sha1-array.h */
for (i = 0; i < array->nr; i++) {
int ret = fn(array->oid + i, data);