Skip to content

Commit 3cab02d

Browse files
committed
Documentation: what does "git log --indexed-objects" even mean?
4fe1021 (rev-list: add --indexed-objects option, 2014-10-16) adds "--indexed-objects" option to "rev-list", and it is only useful in the context of "git rev-list" and not "git log". There are other object traversal options that do not make sense for "git log" that are shown in the manual page. Move the description of "--indexed-objects" to the object traversal section so that it sits together with its friends "--objects", "--objects-edge", etc. and then show them only in "git rev-list" documentation. Acked-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4fe1021 commit 3cab02d

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Documentation/rev-list-options.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,6 @@ explicitly.
172172
Pretend as if all objects mentioned by reflogs are listed on the
173173
command line as `<commit>`.
174174

175-
--indexed-objects::
176-
Pretend as if all trees and blobs used by the index are listed
177-
on the command line. Note that you probably want to use
178-
`--objects`, too.
179-
180175
--ignore-missing::
181176
Upon seeing an invalid object name in the input, pretend as if
182177
the bad input was not given.
@@ -644,6 +639,7 @@ Object Traversal
644639

645640
These options are mostly targeted for packing of Git repositories.
646641

642+
ifdef::git-rev-list[]
647643
--objects::
648644
Print the object IDs of any object referenced by the listed
649645
commits. `--objects foo ^bar` thus means ``send me
@@ -657,9 +653,15 @@ These options are mostly targeted for packing of Git repositories.
657653
objects in deltified form based on objects contained in these
658654
excluded commits to reduce network traffic.
659655

656+
--indexed-objects::
657+
Pretend as if all trees and blobs used by the index are listed
658+
on the command line. Note that you probably want to use
659+
`--objects`, too.
660+
660661
--unpacked::
661662
Only useful with `--objects`; print the object IDs that are not
662663
in packs.
664+
endif::git-rev-list[]
663665

664666
--no-walk[=(sorted|unsorted)]::
665667
Only show the given commits, but do not traverse their ancestors.

0 commit comments

Comments
 (0)