From bb22b078e2ea277ebc039b1f490fa48895a6ec5b Mon Sep 17 00:00:00 2001
From: Simon McVittie <smcv@collabora.com>
Date: Fri, 10 Jan 2025 12:30:52 +0000
Subject: [PATCH] flatpak(1): Sort environment variables alphabetically

Signed-off-by: Simon McVittie <smcv@collabora.com>
---
 doc/flatpak.xml | 77 +++++++++++++++++++++++++------------------------
 1 file changed, 39 insertions(+), 38 deletions(-)

diff --git a/doc/flatpak.xml b/doc/flatpak.xml
index 216b3ed9..e05a9b6c 100644
--- a/doc/flatpak.xml
+++ b/doc/flatpak.xml
@@ -607,6 +607,16 @@
               <envar>XDG_DATA_HOME</envar>, flatpak is consulting some of its own.
             </para>
             <variablelist>
+                <!-- Please keep these in alphabetical order -->
+                <varlistentry>
+                    <term><envar>FLATPAK_CONFIG_DIR</envar></term>
+
+                    <listitem><para>
+                      The location of flatpak site configuration. If this is not set,
+                      <filename>/etc/flatpak</filename> is used (unless overridden at build
+                      time by --sysconfdir).
+                    </para></listitem>
+                </varlistentry>
                 <varlistentry>
                     <term><envar>FLATPAK_FANCY_OUTPUT</envar></term>
                     <listitem><para>
@@ -617,6 +627,35 @@
                         or when <envar>G_MESSAGES_DEBUG</envar> is set.
                     </para></listitem>
                 </varlistentry>
+                <varlistentry>
+                    <term><envar>FLATPAK_RUN_DIR</envar></term>
+
+                    <listitem><para>
+                      The location of flatpak runtime global files. If this is not set,
+                      <filename>/run/flatpak</filename> is used.
+                    </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_SYSTEM_DIR</envar></term>
+
+                    <listitem><para>
+                      The location of the default system-wide installation. If this is not set,
+                      <filename>/var/lib/flatpak</filename> is used (unless overridden at build
+                      time by --localstatedir or --with-system-install-dir).
+                    </para></listitem>
+                </varlistentry>
                 <varlistentry>
                     <term><envar>FLATPAK_TTY_PROGRESS</envar></term>
 
@@ -637,44 +676,6 @@
                       <filename>$XDG_DATA_HOME/flatpak</filename> is used.
                     </para></listitem>
                 </varlistentry>
-                <varlistentry>
-                    <term><envar>FLATPAK_SYSTEM_DIR</envar></term>
-
-                    <listitem><para>
-                      The location of the default system-wide installation. If this is not set,
-                      <filename>/var/lib/flatpak</filename> is used (unless overridden at build
-                      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>
-
-                    <listitem><para>
-                      The location of flatpak site configuration. If this is not set,
-                      <filename>/etc/flatpak</filename> is used (unless overridden at build
-                      time by --sysconfdir).
-                    </para></listitem>
-                </varlistentry>
-                <varlistentry>
-                    <term><envar>FLATPAK_RUN_DIR</envar></term>
-
-                    <listitem><para>
-                      The location of flatpak runtime global files. If this is not set,
-                      <filename>/run/flatpak</filename> is used.
-                    </para></listitem>
-                </varlistentry>
             </variablelist>
     </refsect1>