]> git.ipfire.org Git - thirdparty/snapper.git/commitdiff
- document some types
authorArvin Schnell <aschnell@suse.de>
Thu, 7 Apr 2016 08:24:21 +0000 (10:24 +0200)
committerArvin Schnell <aschnell@suse.de>
Thu, 7 Apr 2016 08:24:21 +0000 (10:24 +0200)
doc/snapper-configs.xml.in

index f7735f7457385d6144d69592dcd0e5ad2d4b4ccc..a0efa8cb3973465cfc05c4ae6d1494ac35d7e0ae 100644 (file)
@@ -52,7 +52,7 @@
       </varlistentry>
 
       <varlistentry>
-       <term><option>QGROUP=<replaceable>value</replaceable></option></term>
+       <term><option>QGROUP=<replaceable>qgroup</replaceable></option></term>
        <listitem>
          <para>The btrfs quota group used for space aware cleanup
          algorithms.</para>
     </variablelist>
   </refsect1>
 
+  <refsect1 id='types'>
+    <title>TYPES</title>
+    <para>Some of the types used for the variables deserve an explanation.</para>
+    <variablelist>
+
+      <varlistentry>
+       <term>range</term>
+       <listitem>
+         <para>A range of numbers given as
+         &lt;max-value&gt;-&lt;min-value&gt;, e.g. &quot;10-20&quot;.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>qgroup</term>
+       <listitem>
+         <para>A btrfs qgroup in the standard form
+         &lt;level&gt;/&lt;id&gt;, e.g. &quot;1/0&quot;.</para>
+       </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
   <refsect1 id='notes'>
     <title>NOTES</title>
     <para>The default values stated here are the values snapper uses when the