mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'jk/document-rev-list-object-name'

Browse Source 
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
This commit is contained in:
Junio C Hamano
2023-04-04 14:28:29 -07:00
parent 45602dd029 15364d2a3c
commit abb3b692a4
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/rev-list-options.txt
View File

@ -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
@ -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