aboutsummaryrefslogtreecommitdiff
path: root/Documentation/technical/api-path-walk.adoc
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2025-08-25 14:22:01 -0700
committerJunio C Hamano <gitster@pobox.com>2025-08-25 14:22:02 -0700
commit0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397 (patch)
treed7c7205b2ae9788e006996be6f8074978f215507 /Documentation/technical/api-path-walk.adoc
parent109c3df14ccf372c2438a470bdfb566265399f0a (diff)
parent84f3d6e11e085a52e561a509f2433208f22c6d3b (diff)
downloadgit-0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397.tar.xz
Merge branch 'ja/doc-lint-sections-and-synopsis'
Doc lint updates to encourage the newer and easier-to-use `synopsis` format, with fixes to a handful of existing uses. * ja/doc-lint-sections-and-synopsis: doc lint: check that synopsis manpages have synopsis inlines doc:git-for-each-ref: fix styling and typos doc: check for absence of the form --[no-]parameter doc: check for absence of multiple terms in each entry of desc list doc: check well-formedness of delimited sections doc: test linkgit macros for well-formedness
Diffstat (limited to 'Documentation/technical/api-path-walk.adoc')
-rw-r--r--Documentation/technical/api-path-walk.adoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/technical/api-path-walk.adoc b/Documentation/technical/api-path-walk.adoc
index 34c905eb9c..a67de1b143 100644
--- a/Documentation/technical/api-path-walk.adoc
+++ b/Documentation/technical/api-path-walk.adoc
@@ -39,7 +39,10 @@ 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`, `tags`::
+`commits`::
+`blobs`::
+`trees`::
+`tags`::
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