diff options
| author | Derrick Stolee <derrickstolee@github.com> | 2024-12-20 16:21:12 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-12-20 08:37:05 -0800 |
| commit | c8dba310d734962c0bcadd8cad1ebf7cfe734c8c (patch) | |
| tree | b594be4998d97ee2ff153c5c19f522a2f8410170 /Documentation/technical/api-path-walk.txt | |
| parent | t6601: add helper for testing path-walk API (diff) | |
| download | git-c8dba310d734962c0bcadd8cad1ebf7cfe734c8c.tar.gz git-c8dba310d734962c0bcadd8cad1ebf7cfe734c8c.zip | |
path-walk: allow consumer to specify object types
We add the ability to filter the object types in the path-walk API so
the callback function is called fewer times.
This adds the ability to ask for the commits in a list, as well. We
re-use the empty string for this set of objects because these are passed
directly to the callback function instead of being part of the
'path_stack'.
Future changes will add the ability to visit annotated tags.
Signed-off-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-path-walk.txt')
| -rw-r--r-- | Documentation/technical/api-path-walk.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/technical/api-path-walk.txt b/Documentation/technical/api-path-walk.txt index 662162ec70..dce553b611 100644 --- a/Documentation/technical/api-path-walk.txt +++ b/Documentation/technical/api-path-walk.txt @@ -39,6 +39,15 @@ It is also important that you do not specify the `--objects` flag for the the objects will be walked in a separate way based on those starting commits. +`commits`, `blobs`, `trees`:: + By default, these members are enabled and signal that the path-walk + API should call the `path_fn` on objects of these types. Specialized + applications could disable some options to make it simpler to walk + the objects or to have fewer calls to `path_fn`. ++ +While it is possible to walk only commits in this way, consumers would be +better off using the revision walk API instead. + Examples -------- |