Skip to content

Commit abb3b69

Browse files
committed
Merge branch 'jk/document-rev-list-object-name'
Document what the pathname-looking strings in "rev-list --object" output are for and what they mean. * jk/document-rev-list-object-name: docs: document caveats of rev-list's object-name output
2 parents 45602dd + 15364d2 commit abb3b69

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

Documentation/rev-list-options.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,7 @@ ifdef::git-rev-list[]
890890
Print the object IDs of any object referenced by the listed
891891
commits. `--objects foo ^bar` thus means ``send me
892892
all object IDs which I need to download if I have the commit
893-
object _bar_ but not _foo_''.
893+
object _bar_ but not _foo_''. See also `--object-names` below.
894894

895895
--in-commit-order::
896896
Print tree and blob ids in order of the commits. The tree
@@ -920,7 +920,12 @@ ifdef::git-rev-list[]
920920

921921
--object-names::
922922
Only useful with `--objects`; print the names of the object IDs
923-
that are found. This is the default behavior.
923+
that are found. This is the default behavior. Note that the
924+
"name" of each object is ambiguous, and mostly intended as a
925+
hint for packing objects. In particular: no distinction is made between
926+
the names of tags, trees, and blobs; path names may be modified
927+
to remove newlines; and if an object would appear multiple times
928+
with different names, only one name is shown.
924929

925930
--no-object-names::
926931
Only useful with `--objects`; does not print the names of the object

0 commit comments

Comments
 (0)