Skip to content

Commit

Permalink
Merge branch 'jk/document-rev-list-object-name'
Browse files Browse the repository at this point in the history
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
  • Loading branch information
gitster committed Apr 4, 2023
2 parents 45602dd + 15364d2 commit abb3b69
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions Documentation/rev-list-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,7 @@ ifdef::git-rev-list[]
Print the object IDs of any object referenced by the listed
commits. `--objects foo ^bar` thus means ``send me
all object IDs which I need to download if I have the commit
object _bar_ but not _foo_''.
object _bar_ but not _foo_''. See also `--object-names` below.

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

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

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

0 comments on commit abb3b69

Please sign in to comment.