Documentation: what does "git log --indexed-objects" even mean?

4fe10219 (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 <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano
2015-01-23 11:49:05 -08:00
parent 4fe10219bc
commit 3cab02de50

View File

@ -172,11 +172,6 @@ explicitly.
Pretend as if all objects mentioned by reflogs are listed on the Pretend as if all objects mentioned by reflogs are listed on the
command line as `<commit>`. command line as `<commit>`.
--indexed-objects::
Pretend as if all trees and blobs used by the index are listed
on the command line. Note that you probably want to use
`--objects`, too.
--ignore-missing:: --ignore-missing::
Upon seeing an invalid object name in the input, pretend as if Upon seeing an invalid object name in the input, pretend as if
the bad input was not given. the bad input was not given.
@ -644,6 +639,7 @@ Object Traversal
These options are mostly targeted for packing of Git repositories. These options are mostly targeted for packing of Git repositories.
ifdef::git-rev-list[]
--objects:: --objects::
Print the object IDs of any object referenced by the listed Print the object IDs of any object referenced by the listed
commits. `--objects foo ^bar` thus means ``send me commits. `--objects foo ^bar` thus means ``send me
@ -657,9 +653,15 @@ These options are mostly targeted for packing of Git repositories.
objects in deltified form based on objects contained in these objects in deltified form based on objects contained in these
excluded commits to reduce network traffic. excluded commits to reduce network traffic.
--indexed-objects::
Pretend as if all trees and blobs used by the index are listed
on the command line. Note that you probably want to use
`--objects`, too.
--unpacked:: --unpacked::
Only useful with `--objects`; print the object IDs that are not Only useful with `--objects`; print the object IDs that are not
in packs. in packs.
endif::git-rev-list[]
--no-walk[=(sorted|unsorted)]:: --no-walk[=(sorted|unsorted)]::
Only show the given commits, but do not traverse their ancestors. Only show the given commits, but do not traverse their ancestors.