Git 2.23
[gitweb.git] / Documentation / git-count-objects.txt
index 47216f488b444e2d9f37c302a71b9ac496b928a5..cb9b4d2e460adaa46ee863c37283840c2bdb9333 100644 (file)
@@ -3,26 +3,52 @@ git-count-objects(1)
 
 NAME
 ----
-git-count-objects - Reports on unpacked objects
+git-count-objects - Count unpacked number of objects and their disk consumption
 
 SYNOPSIS
 --------
-'git-count-objects'
+[verse]
+'git count-objects' [-v] [-H | --human-readable]
 
 DESCRIPTION
 -----------
 This counts the number of unpacked object files and disk space consumed by
 them, to help you decide when it is a good time to repack.
 
-Author
-------
-Written by Junio C Hamano <junkio@cox.net>
 
-Documentation
---------------
-Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+OPTIONS
+-------
+-v::
+--verbose::
+       Report in more detail:
++
+count: the number of loose objects
++
+size: disk space consumed by loose objects, in KiB (unless -H is specified)
++
+in-pack: the number of in-pack objects
++
+size-pack: disk space consumed by the packs, in KiB (unless -H is specified)
++
+prune-packable: the number of loose objects that are also present in
+the packs. These objects could be pruned using `git prune-packed`.
++
+garbage: the number of files in object database that are neither valid loose
+objects nor valid packs
++
+size-garbage: disk space consumed by garbage files, in KiB (unless -H is
+specified)
++
+alternate: absolute path of alternate object databases; may appear
+multiple times, one line per path. Note that if the path contains
+non-printable characters, it may be surrounded by double-quotes and
+contain C-style backslashed escape sequences.
+
+-H::
+--human-readable::
+
+Print sizes in human readable format
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite