From ada5716fb2843d4cd431150da6a0de0a65d8cb3a Mon Sep 17 00:00:00 2001 From: Will Thompson Date: Fri, 17 Aug 2018 13:14:17 +0100 Subject: [PATCH] man/ostree.repo-config: improve min-free-space-* docs 0 is not a valid value (the units are required), and 1MB is taken to mean 1048576 bytes, not 1000000 bytes (unlike other human-readable sizes in libostree, which are formatted by g_format_size(), and hence use power-of-10 units). It's probably a bit late to change this latter point, but the documentation should mention it. Define 'MB' etc. more precisely; include the byte counts in the examples; and improve the formatting of the min-free-space-* paragraphs. Signed-off-by: Will Thompson Closes: #1706 Approved by: mwleeds --- man/ostree.repo-config.xml | 40 +++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/man/ostree.repo-config.xml b/man/ostree.repo-config.xml index bb406a2e..dc126d65 100644 --- a/man/ostree.repo-config.xml +++ b/man/ostree.repo-config.xml @@ -129,24 +129,36 @@ Boston, MA 02111-1307, USA. min-free-space-percent - Integer percentage value (0-99) that specifies a minimum - percentage of total space (in blocks) in the underlying filesystem to - keep free. The default value is 3. This default value is enforced when none - of min-free-space-* options are set. - In case this option is co-existing with min-free-space-size (see below), - and min-free-space-size is set to a non-zero value, min-free-space-percent - would be ignored and min-free-space-size check would be enforced instead. - + + + Integer percentage value (0-99) that specifies a minimum percentage + of total space (in blocks) in the underlying filesystem to keep + free. The default value is 3, which is enforced when neither this + option nor min-free-space-size are set. + + + If min-free-space-size is set to a non-zero + value, min-free-space-percent is ignored. + + min-free-space-size - Value (in MB, GB or TB) that specifies a minimum space in the - underlying filesystem to keep free. Examples of acceptable values: 500MB, 1GB - etc. - In case this option is co-existing with min-free-space-percent (see above), - and set to a non-zero value, this option takes priority. - + + + Value (in power-of-2 MB, GB or TB) that specifies a minimum space + in the underlying filesystem to keep free. Examples of acceptable + values: 500MB (524 288 000 bytes), + 1GB (1 073 741 824 bytes), + 1TB (1 099 511 627 776 bytes). + + + If this option is set to a non-zero value, and + min-free-space-percent is also set, this option + takes priority. + +