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>
Junio C Hamano committed
Jan 23, 2015 at 11:49 UTC
3cab02de5087447e1c48ada03a0db0fffc89e920
1 file changed
+7
-5
Documentation/rev-list-options.txt
+7
-5
@@ -172,11 +172,6 @@ explicitly.
172
Pretend as if all objects mentioned by reflogs are listed on the
173
command line as `<commit>`.
174
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
-
175
--ignore-missing::
176
Upon seeing an invalid object name in the input, pretend as if
177
the bad input was not given.
@@ -644,6 +639,7 @@ Object Traversal
639
640
These options are mostly targeted for packing of Git repositories.
641
642
+ifdef::git-rev-list[]
643
--objects::
644
Print the object IDs of any object referenced by the listed
645
commits. `--objects foo ^bar` thus means ``send me
@@ -657,9 +653,15 @@ These options are mostly targeted for packing of Git repositories.
653
objects in deltified form based on objects contained in these
654
excluded commits to reduce network traffic.
655
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
+
661
--unpacked::
662
Only useful with `--objects`; print the object IDs that are not
663
in packs.
664
+endif::git-rev-list[]
665
666
--no-walk[=(sorted|unsorted)]::
667
Only show the given commits, but do not traverse their ancestors.