summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorAntoine Pelisse <apelisse@gmail.com>2013-04-10 19:03:23 (GMT)
committerJunio C Hamano <gitster@pobox.com>2013-04-10 19:58:33 (GMT)
commit079b546a2940a84989893254a318c8414e13a13e (patch)
tree5f8cc69cbfa12a63cf23b6dfdd75f92eefb4b9ef /Documentation
parentfa7285dc3dce8bd01fd8c665b032603ed55348e5 (diff)
downloadgit-079b546a2940a84989893254a318c8414e13a13e.zip
git-079b546a2940a84989893254a318c8414e13a13e.tar.gz
git-079b546a2940a84989893254a318c8414e13a13e.tar.bz2
strbuf: create strbuf_humanise_bytes() to show byte sizes
Humanization of downloaded size is done in the same function as text formatting in 'process.c'. The code cannot be reused easily elsewhere. Separate text formatting from size simplification and make the function public in strbuf so that it can easily be used by other callers. We now can use strbuf_humanise_bytes() for both downloaded size and download speed calculation. One of the drawbacks is that speed will now look like this when download is stalled: "0 bytes/s" instead of "0 KiB/s". Signed-off-by: Antoine Pelisse <apelisse@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/technical/api-strbuf.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt
index 2c59cb2..3350d97 100644
--- a/Documentation/technical/api-strbuf.txt
+++ b/Documentation/technical/api-strbuf.txt
@@ -230,6 +230,11 @@ which can be used by the programmer of the callback as she sees fit.
destination. This is useful for literal data to be fed to either
strbuf_expand or to the *printf family of functions.
+`strbuf_humanise_bytes`::
+
+ Append the given byte size as a human-readable string (i.e. 12.23 KiB,
+ 3.50 MiB).
+
`strbuf_addf`::
Add a formatted string to the buffer.