summaryrefslogtreecommitdiff
path: root/scripts/library/README
diff options
context:
space:
mode:
authorDave Reisner <dreisner@archlinux.org>2012-05-06 18:27:43 -0400
committerDan McGee <dan@archlinux.org>2012-06-25 23:39:34 -0500
commita98fce08968febe7395b30f15f070f400da089ed (patch)
tree419123b22846a05a0eda74db324b6d3741208539 /scripts/library/README
parentab8431c92953c4562af214e5170f8ef321037108 (diff)
scripts/library: add size_to_human
This function is the reverse of human_to_size, and converts integer byte sizes to human readable SI prefixed values. A logical extension of this might be to mimic the formatter that pacman uses and allow a second argument to be passed in which can coerce the size, rather than reducing until the unit count is below 1024. Signed-off-by: Dave Reisner <dreisner@archlinux.org>
Diffstat (limited to 'scripts/library/README')
-rw-r--r--scripts/library/README4
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/library/README b/scripts/library/README
index 44748ee2..0fa0f847 100644
--- a/scripts/library/README
+++ b/scripts/library/README
@@ -35,3 +35,7 @@ successful, the converted byte value is written to stdout and the function
returns 0. If an error occurs, nothing in written and the function returns 1.
Results may be inaccurate when using a broken implementation of awk, such
as mawk or busybox awk.
+
+size_to_human.sh:
+The reverse of human_to_size, this function takes an integer byte size and
+prints its in human readable format, with SI prefixes (e.g. MiB, TiB).