diff options
| author | Junio C Hamano <gitster@pobox.com> | 2023-04-04 14:28:29 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-04-04 14:28:29 -0700 |
| commit | abb3b692a4aaa2b9a34e32f171aa7d829d3d26b9 (patch) | |
| tree | 601e383ab6525e7e665048d54f4c8ec8f4e5bda7 | |
| parent | Merge branch 'ar/test-cleanup-unused-file-creation' (diff) | |
| parent | docs: document caveats of rev-list's object-name output (diff) | |
| download | git-abb3b692a4aaa2b9a34e32f171aa7d829d3d26b9.tar.gz git-abb3b692a4aaa2b9a34e32f171aa7d829d3d26b9.zip | |
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
| -rw-r--r-- | Documentation/rev-list-options.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 90c73d6708..3000888a90 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -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 |