path: root/Documentation/technical
diff options
authorJunio C Hamano <>2015-08-03 18:01:13 (GMT)
committerJunio C Hamano <>2015-08-03 18:01:13 (GMT)
commite12b51e4d685c30f488c99c5d89f3310c3fcd9b0 (patch)
tree57edea5f304464e3865ffecc6fb475b41f2fa0e8 /Documentation/technical
parentba12cb299f831f29c256c644b01108710c2629e6 (diff)
parent2a514ed8058e35841d3d7b05a898991b83e5eaf0 (diff)
Merge branch 'cb/parse-magnitude'
Move machinery to parse human-readable scaled numbers like 1k, 4M, and 2G as an option parameter's value from pack-objects to parse-options API, to make it available to other codepaths. * cb/parse-magnitude: parse-options: move unsigned long option parsing out of pack-objects.c test-parse-options: update to handle negative ints
Diffstat (limited to 'Documentation/technical')
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 1f2db31..525cb2f 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt
@@ -168,6 +168,12 @@ There are some macros to easily define options:
Introduce an option with integer argument.
The integer is put into `int_var`.
+`OPT_MAGNITUDE(short, long, &unsigned_long_var, description)`::
+ Introduce an option with a size argument. The argument must be a
+ non-negative integer and may include a suffix of 'k', 'm' or 'g' to
+ scale the provided value by 1024, 1024^2 or 1024^3 respectively.
+ The scaled value is put into `unsigned_long_var`.
`OPT_DATE(short, long, &int_var, description)`::
Introduce an option with date argument, see `approxidate()`.
The timestamp is put into `int_var`.