man/ostree.repo-config: Document locking options
authorMatthew Leeds <matthew.leeds@endlessm.com>
Fri, 28 Sep 2018 01:30:10 +0000 (18:30 -0700)
committerAtomic Bot <atomic-devel@projectatomic.io>
Fri, 28 Sep 2018 15:49:11 +0000 (15:49 +0000)
This commit documents the "locking" and "lock-timeout-secs" options
which have been around for a few releases.

Closes: #1737
Approved by: jlebon

man/ostree.repo-config.xml

index dc126d65d277ed004f2e2cbfce88c03fdf925042..8942a00bcb5e6c497a94a86bc762223d4b642ac5 100644 (file)
@@ -198,6 +198,23 @@ Boston, MA 02111-1307, USA.
         </para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><varname>locking</varname></term>
+        <listitem><para>Boolean value controlling whether or not OSTree does
+        repository locking internally. This uses file locks and is
+        hence for multiple process exclusion (e.g. Flatpak and OSTree
+        writing to the same repository separately). This is enabled by
+        default since 2018.5.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>lock-timeout-secs</varname></term>
+        <listitem><para>Integer value controlling the number of seconds to
+        block while attempting to acquire a lock (see above). A value
+        of -1 means block indefinitely. The default value is 30.
+        </para></listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>