Merge branch 'jk/rev-list-disk-usage'

[thirdparty/git.git] / Documentation / rev-list-options.txt

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 96cc89d157d21f0cbf9cee35db0c49bc4cb18dae..1238bfd915d23144ad60260609780f138f80785c 100644 (file)
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -227,6 +227,15 @@ ifdef::git-rev-list[]
        test the exit status to see if a range of objects is fully
        connected (or not).  It is faster than redirecting stdout
        to `/dev/null` as the output does not have to be formatted.
+
+--disk-usage::
+       Suppress normal output; instead, print the sum of the bytes used
+       for on-disk storage by the selected commits or objects. This is
+       equivalent to piping the output into `git cat-file
+       --batch-check='%(objectsize:disk)'`, except that it runs much
+       faster (especially with `--use-bitmap-index`). See the `CAVEATS`
+       section in linkgit:git-cat-file[1] for the limitations of what
+       "on-disk storage" means.
 endif::git-rev-list[]
 
 --cherry-mark::