From: Arvin Schnell <aschnell@suse.de>
Date: Thu, 7 Apr 2016 08:24:21 +0000 (+0200)
Subject: - document some types
X-Git-Tag: v0.3.3~10^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e69ab32cc5620b59010e578932018594a315714f;p=thirdparty%2Fsnapper.git

- document some types
---

diff --git a/doc/snapper-configs.xml.in b/doc/snapper-configs.xml.in
index f7735f74..a0efa8cb 100644
--- a/doc/snapper-configs.xml.in
+++ b/doc/snapper-configs.xml.in
@@ -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>
@@ -266,6 +266,30 @@
     </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