man/ostree.repo-config: Update min-free-space-* docs

Now that it's possible to have both min-free-space-size and
min-free-space-percent set in a repo config, update the docs to make
the behavior clear in that case.

Closes: #1687
Approved by: jlebon
This commit is contained in:
Matthew Leeds 2018-07-22 19:19:52 -07:00 committed by Atomic Bot
parent be07c04e63
commit 799cfcb5b3
1 changed files with 8 additions and 5 deletions

View File

@ -121,18 +121,21 @@ Boston, MA 02111-1307, USA.
<term><varname>min-free-space-percent</varname></term>
<listitem><para>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.</para>
keep free. The default value is 3. This default value is enforced when none
of min-free-space-* options are set.</para>
<para>In case this option is co-existing with min-free-space-size (see below),
it would be ignored and min-free-space-size check would be enforced instead.
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>min-free-space-size</varname></term>
<listitem><para>Value (in MB, GB or TB) that specifies a minimum space in the
underlying filesystem to keep free. Also, note that min-free-space-percent
and min-free-space-size are mutually exclusive. Examples of acceptable values:
500MB, 1GB etc. The default value is 0MB, which disables this check.
underlying filesystem to keep free. Examples of acceptable values: 500MB, 1GB
etc.</para>
<para>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.
</para></listitem>
</varlistentry>