aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2025-02-18 15:30:32 -0800
committerJunio C Hamano <gitster@pobox.com>2025-02-18 15:30:32 -0800
commit7722b997c65b99aa824f83fd8e674ae77ea698f3 (patch)
tree5eb23240d10b98e715f719fe533626dff8d558e9 /Documentation
parent345aaf3976a6abc491026c8a465b5e8ccbc8da5a (diff)
parent3295c3539896750f742a56de0c4ac965f8d96303 (diff)
downloadgit-7722b997c65b99aa824f83fd8e674ae77ea698f3.tar.xz
Merge branch 'jt/rev-list-missing-print-info'
"git rev-list --missing=" learned to accept "print-info" that gives known details expected of the missing objects, like path and type. * jt/rev-list-missing-print-info: rev-list: extend print-info to print missing object type rev-list: add print-info action to print missing object path
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/rev-list-options.adoc19
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/rev-list-options.adoc b/Documentation/rev-list-options.adoc
index 196b2781cc..785c0786e0 100644
--- a/Documentation/rev-list-options.adoc
+++ b/Documentation/rev-list-options.adoc
@@ -1024,6 +1024,25 @@ Unexpected missing objects will raise an error.
The form '--missing=print' is like 'allow-any', but will also print a
list of the missing objects. Object IDs are prefixed with a ``?'' character.
+
+The form '--missing=print-info' is like 'print', but will also print additional
+information about the missing object inferred from its containing object. The
+information is all printed on the same line with the missing object ID in the
+form: `?<oid> [<token>=<value>]...`. The `<token>=<value>` pairs containing
+additional information are separated from each other by a SP. The value is
+encoded in a token specific fashion, but SP or LF contained in value are always
+expected to be represented in such a way that the resulting encoded value does
+not have either of these two problematic bytes. Each `<token>=<value>` may be
+one of the following:
++
+--
+* The `path=<path>` shows the path of the missing object inferred from a
+ containing object. A path containing SP or special characters is enclosed in
+ double-quotes in the C style as needed.
++
+* The `type=<type>` shows the type of the missing object inferred from a
+ containing object.
+--
++
If some tips passed to the traversal are missing, they will be
considered as missing too, and the traversal will ignore them. In case
we cannot get their Object ID though, an error will be raised.