averello/git-mirror
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2025-12-12 20:36:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

tree-walk.h: fix incorrect API comment

Browse Source 
When commit 50ddb089ff (tree-walk.c: remove the_repo from
get_tree_entry(), 2019-06-27) added an extra parameter to
get_tree_entry(), it did not fix the ordering comment about the meaning
of the parameters.  Rather than just changing "third"->"fourth" and
"fourth"->"fifth", give the paramemters meaningful names (or actually,
just take the existing names from the get_tree_entry() definition in the
tree-walk.c file) and while at it, tweak the rest of the description to
incorporate the other parameter names as well.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Elijah Newren
2025-05-02 19:19:11 +00:00
committed by Junio C Hamano
parent d50a5e8939
commit f62977b93c
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tree-walk.h
View File

@@ -176,11 +176,14 @@ struct traverse_info {
};
/**
* Find an entry in a tree given a pathname and the sha1 of a tree to
* search. Returns 0 if the entry is found and -1 otherwise. The third
* and fourth parameters are set to the entry's sha1 and mode respectively.
* Walk trees starting with "tree_oid" to find the entry for "name", and
* return the the object name and the mode of the found entry via the
* "oid" and "mode" parameters. Return 0 if the entry is found, and -1
* otherwise.
*/
int get_tree_entry(struct repository *, const struct object_id *, const char *, struct object_id *, unsigned short *);
int get_tree_entry(struct repository *repo, const struct object_id *tree_oid,
const char *name, struct object_id *oid,
unsigned short *mode);
/**
* Generate the full pathname of a tree entry based from the root of the