diff options
| author | Junio C Hamano <gitster@pobox.com> | 2025-05-13 14:05:05 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-05-13 14:05:06 -0700 |
| commit | f2cc60c053c8c07d52a42d11a717fe7cc55afc63 (patch) | |
| tree | 3206840012e64a1bb7f92d1c84ee02ea2134650d | |
| parent | The thirteenth batch (diff) | |
| parent | tree-walk.h: fix incorrect API comment (diff) | |
| download | git-f2cc60c053c8c07d52a42d11a717fe7cc55afc63.tar.gz git-f2cc60c053c8c07d52a42d11a717fe7cc55afc63.zip | |
Merge branch 'en/get-tree-entry-doc'
Doc update.
* en/get-tree-entry-doc:
tree-walk.h: fix incorrect API comment
| -rw-r--r-- | tree-walk.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/tree-walk.h b/tree-walk.h index aaea689f9a..29a55328bd 100644 --- a/tree-walk.h +++ b/tree-walk.h @@ -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. - */ -int get_tree_entry(struct repository *, const struct object_id *, const char *, struct object_id *, unsigned short *); + * 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 *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 |