From 5e710cb995069aa51f84f4c0964bbab2fbf7577e Mon Sep 17 00:00:00 2001
From: Matthew Leeds <matthew.leeds@endlessm.com>
Date: Fri, 19 Apr 2019 16:06:13 -0700
Subject: [PATCH] doc/flatpak: Document FLATPAK_SYSTEM_CACHE_DIR

This environment variable has been used for a while; it's just
undocumented. Copy some information from a comment in flatpak-dir.c.

Closes: #2841
Approved by: matthiasclasen
---
 doc/flatpak.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/flatpak.xml b/doc/flatpak.xml
index fbabbc73..c84f509a 100644
--- a/doc/flatpak.xml
+++ b/doc/flatpak.xml
@@ -562,6 +562,18 @@
                       time by --localstatedir or --with-system-install-dir).
                     </para></listitem>
                 </varlistentry>
+                <varlistentry>
+                    <term><envar>FLATPAK_SYSTEM_CACHE_DIR</envar></term>
+
+                    <listitem><para>
+                      The location where temporary child repositories will be created during pulls
+                      into the system-wide installation.  If this is not set, a directory in
+                      <filename>/var/tmp/</filename> is used. This is useful because it is more
+                      likely to be on the same filesystem as the system repository (thus increasing
+                      the chances for e.g. reflink copying), and we can avoid filling the user's
+                      home directory with temporary data.
+                    </para></listitem>
+                </varlistentry>
                 <varlistentry>
                     <term><envar>FLATPAK_CONFIG_DIR</envar></term>