packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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 <wjt@endlessm.com>

Closes: #1706
Approved by: mwleeds
This commit is contained in:
Will Thompson 2018-08-17 13:14:17 +01:00 committed by Atomic Bot
parent 57dbd176e9
commit ada5716fb2
1 changed files with 26 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
man/ostree.repo-config.xml
View File

@ -129,24 +129,36 @@ Boston, MA 02111-1307, USA.
<varlistentry> <varlistentry>
<term><varname>min-free-space-percent</varname></term> <term><varname>min-free-space-percent</varname></term>
<listitem><para>Integer percentage value (0-99) that specifies a minimum <listitem>
percentage of total space (in blocks) in the underlying filesystem to <para>
keep free. The default value is 3. This default value is enforced when none Integer percentage value (0-99) that specifies a minimum percentage
of min-free-space-* options are set.</para> of total space (in blocks) in the underlying filesystem to keep
<para>In case this option is co-existing with min-free-space-size (see below), free. The default value is 3, which is enforced when neither this
and min-free-space-size is set to a non-zero value, min-free-space-percent option nor <varname>min-free-space-size</varname> are set.
would be ignored and min-free-space-size check would be enforced instead. </para>
</para></listitem> <para>
If <varname>min-free-space-size</varname> is set to a non-zero
value, <varname>min-free-space-percent</varname> is ignored.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>min-free-space-size</varname></term> <term><varname>min-free-space-size</varname></term>
<listitem><para>Value (in MB, GB or TB) that specifies a minimum space in the <listitem>
underlying filesystem to keep free. Examples of acceptable values: 500MB, 1GB <para>
etc.</para> Value (in power-of-2 MB, GB or TB) that specifies a minimum space
<para>In case this option is co-existing with min-free-space-percent (see above), in the underlying filesystem to keep free. Examples of acceptable
and set to a non-zero value, this option takes priority. values: <literal>500MB</literal> (524 288 000 bytes),
</para></listitem> <literal>1GB</literal> (1 073 741 824 bytes),
<literal>1TB</literal> (1 099 511 627 776 bytes).
</para>
<para>
If this option is set to a non-zero value, and
<varname>min-free-space-percent</varname> is also set, this option
takes priority.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>