Changeset 460609c

Timestamp:

06/10/2023 11:18:15 AM (12 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

12.0, 12.1, kea, ken/TL2024, ken/tuningfonts, lazarus, lxqt, plabs/newcss, python3.11, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal

Children:

d37d7c5

Parents:

2980344

git-author:

Xi Ruoyao <xry111@…> (06/10/2023 10:59:31 AM)

git-committer:

Xi Ruoyao <xry111@…> (06/10/2023 11:18:15 AM)

Message:

mutter: Reword test instruction

• Clutter tests do not work well with buildtype=release, so disable them
• Use gtk4-demo instead of gtk3-demo as mutter is now a GTK4 application
• Also remove "GTK3 needs to be built with Wayland" (GTK4 always requires wayland)
• Document a known failure
• Add libmutter-test-12 (optional) into short description

File:

• gnome/platform/mutter.xml (modified) (10 diffs)

gnome/platform/mutter.xml

@@ -101 +101 @@
       <xref linkend="wayland-protocols"/>, and
       <xref linkend="xwayland"/>.
-      Additionally, <xref linkend="gtk3"/> needs to be built with
-      <application>Wayland</application> support.
     </para>
 
@@ -117 +115 @@
     </para>
 
-    <!-- NOTE: Mutter compiles git versions of COGL and Clutter for it's own
-    internal use. This is because the wayland support upstream isn't advanced
-    enough for the graphics stack used in Mutter. -->
+    <!-- NOTE: Mutter compiles shipped Cogl and Clutter for it's own
+    internal use. This is because the upstream has decided that Cogl and
+    Clutter should be only used by Mutter in the future, so the development
+    of Cogl and Clutter is now performed in the Mutter repository.  The
+    "standalone" Cogl and Clutter are considered obsolete now and we should
+    try to archive them.  -->
 
     <para condition="html" role="usernotes">User Notes:
@@ -164 +165 @@
 
     <para>
-      The test suite requires debug functions to be enabled in the build, and an
+      The test suite requires an
       external program called <command>xvfb-run</command>.  If you wish to run
       the tests, you should download and install it before running
@@ -179 +180 @@
       You should also replace <parameter>-Dtests=false</parameter> in the
       <command>meson</command> command, with
-      <parameter>-Dtests=true</parameter>.  The test
+      <parameter>-Dtests=true -Dclutter_tests=false</parameter>.  The test
       suite requires the mutter schema to be installed on the system, so it is
       better to run the tests after installing the package.
@@ -201 +202 @@
     </para>
 
-<screen role='test'><userinput>sed 's/zenity --[a-z]*/gtk3-demo/' -i ../src/tests/x11-test.sh</userinput></screen>
+<screen role='test'><userinput>sed 's/zenity --[a-z]*/gtk4-demo/' -i ../src/tests/x11-test.sh</userinput></screen>
 
     <para>
@@ -213 +214 @@
     <para>
       The tests require an active X or wayland session.
-      The <filename>native-unit</filename> test is known to fail.
+      <!-- https://gitlab.gnome.org/GNOME/mutter/-/issues/2848 -->
+      The <filename>test_framebuffer_get_bits</filename> test is known to fail.
       A lot of tests will fail if the opengl rendering is not done in hardware.
       Don't make any mouse or keyboard input while the test suite is
       running or some tests may fail.
     </para>
+
   </sect2>
 
   <sect2 role="commands">
     <title>Command Explanations</title>
-
-    <!-- https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/5512
-         If debug is disabled, the "assertion 'CLUTTER_IS_ACTOR (self)'
-         failed" message will turn into a crash.  Enabling debug is just a
-         work around, it's not a proper fix.
-    <para>
-      <parameter>- -buildtype=debugoptimized</parameter>: Override the
-      default buildtype (<quote>debug</quote>), which would produce
-      unoptimized binaries.  It's used instead of
-      <option>- -buildtype=release</option> to work around an issue
-      causing gnome-shell to crash.
-    </para>
-    -->
 
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -251 +241 @@
     </para>
 
+    <para>
+      <option>-Dtests=true -Dclutter-tests=false</option>: Building all the
+      tests but the tests for the shipped <application>Clutter</application>
+      library.  The <application>Clutter</application> tests are known to
+      fail with <option>--buildtype=release</option>.
+    </para>
+
   </sect2>
 
@@ -256 +253 @@
     <title>Starting Mutter</title>
 
-    <!-- Mutter as a Wayland compositor Works with mutter-42.4 and 43.0.
+    <!-- Mutter as a Wayland compositor works with recent mutter releases.
          IIRC mutter can also be used as a X window manager: just replace
          "twm" with "mutter &dash;&dash;x11" in xinitrc. But I've not tested
@@ -304 +301 @@
         </seg>
         <seg>
-          libmutter-12.so
+          libmutter-12.so and libmutter-test-12.so (optional)
         </seg>
         <seg>
@@ -342 +339 @@
       </varlistentry>
 
+      <varlistentry id="libmutter-test">
+        <term><filename class="libraryfile">libmutter-test-12.so</filename></term>
+        <listitem>
+          <para>
+            contains the <application>Mutter</application> test suite API
+            functions; this library is only installed if the test suite of
+            this package is enabled and it is needed by
+            <application>gnome-shell</application> test suite
+          </para>
+          <indexterm zone="mutter libmutter-test">
+            <primary sortas="c-libmutter-test">libmutter-test-12.so</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
+
     </variablelist>