Skip to content

Commit

Permalink
Documentation: what does "git log --indexed-objects" even mean?
Browse files Browse the repository at this point in the history
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 <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Junio C Hamano committed Jan 23, 2015
1 parent 4fe1021 commit 3cab02d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions Documentation/rev-list-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,6 @@ explicitly.
Pretend as if all objects mentioned by reflogs are listed on the
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::
Upon seeing an invalid object name in the input, pretend as if
the bad input was not given.
Expand Down Expand Up @@ -644,6 +639,7 @@ Object Traversal

These options are mostly targeted for packing of Git repositories.

ifdef::git-rev-list[]
--objects::
Print the object IDs of any object referenced by the listed
commits. `--objects foo ^bar` thus means ``send me
Expand All @@ -657,9 +653,15 @@ These options are mostly targeted for packing of Git repositories.
objects in deltified form based on objects contained in these
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::
Only useful with `--objects`; print the object IDs that are not
in packs.
endif::git-rev-list[]

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

0 comments on commit 3cab02d

Please sign in to comment.