From 1ce321d6b78eff6ed14d1f2161e4c0d16ba55a1b Mon Sep 17 00:00:00 2001
From: Xi Ruoyao <xry111@xry111.site>
Date: Fri, 18 Aug 2023 20:55:35 +0800
Subject: [PATCH] gnome-shell: Document known failure

See the added comment for details.
---
 gnome/platform/gnome-shell.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/gnome/platform/gnome-shell.xml b/gnome/platform/gnome-shell.xml
index b99cd89282..4e6e260c45 100644
--- a/gnome/platform/gnome-shell.xml
+++ b/gnome/platform/gnome-shell.xml
@@ -160,6 +160,20 @@ ninja</userinput></screen>
       running an X session to run the tests. Some will fail if <xref
       linkend="gdm"/> is not installed. <phrase revision="sysv">Several
       more tests may fail in the Sysv environment.</phrase>
+      <!-- "Failed to read monitors config file
+           '/home/xry111/.config/monitors.xml': Logical monitors not
+           adjacent"
+           The same thing happens in mutter but it's worked around with
+           HOME="".  We cannot use HOME="" here or more tests will fail.
+           We also cannot tell the users to remove monitors.xml because
+           doing so will purge their monitor settings.  Maybe we can
+           use bwrap to run the test with an empty tmpfs mounted on $HOME
+           in a separate namespace, but it's too overkill IMO.
+           DO NOT REMOVE unless you've tested with a "complex multi-monitor
+           configuration" (with mixed scaling settings and "strange"
+           positions of monitors). -->
+      One test named <filename>CSS styling support</filename> is known to
+      fail with some multi-monitor configurations.
     </para>
 
     <para>