Changes in gnome/platform/mutter.xml [88e7954:e1d37d8]

File:

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

gnome/platform/mutter.xml

@@ -5 +5 @@
   %general-entities;
 
-  <!ENTITY mutter-download-http "&gnome-download-http;/mutter/&gnome-40;/mutter-&mutter-version;.tar.xz">
-  <!ENTITY mutter-download-ftp  "&gnome-download-ftp;/mutter/&gnome-40;/mutter-&mutter-version;.tar.xz">
-  <!ENTITY mutter-md5sum        "bbfb54fba942b4f388e5b89759f2e9a6">
-  <!ENTITY mutter-size          "2.6 MB">
-  <!ENTITY mutter-buildsize     "296 MB">
-  <!ENTITY mutter-time          "2.1 SBU (Using parallelism=4)">
+  <!ENTITY mutter-download-http "&gnome-download-http;/mutter/&gnome-43;/mutter-&mutter-version;.tar.xz">
+  <!ENTITY mutter-download-ftp  "&gnome-download-ftp;/mutter/&gnome-43;/mutter-&mutter-version;.tar.xz">
+  <!ENTITY mutter-md5sum        "2aa9fae86f51490b419e747885069e96">
+  <!ENTITY mutter-size          "2.7 MB">
+  <!ENTITY mutter-buildsize     "150 MB (without tests)">
+  <!ENTITY mutter-time          "0.6 SBU (Using parallelism=4)">
+  <!ENTITY mutter-time-systemd  "0.6 SBU (Using parallelism=4, add 1.0 SBU for tests)">
 ]>
 
@@ -16 +17 @@
   <?dbhtml filename="mutter.html"?>
 
-  <sect1info>
-    <date>$Date$</date>
-  </sect1info>
 
   <title>Mutter-&mutter-version;</title>
@@ -36 +34 @@
     </para>
 
-    &lfs110a_checked;
+    &lfs112_checked;
 
     <bridgehead renderas="sect3">Package Information</bridgehead>
@@ -65 +63 @@
         </para>
       </listitem>
-      <listitem>
+      <listitem revision='sysv'>
         <para>
           Estimated build time: &mutter-time;
         </para>
       </listitem>
+      <listitem revision='systemd'>
+        <para>
+          Estimated build time: &mutter-time-systemd;
+        </para>
+      </listitem>
     </itemizedlist>
-<!--
-    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
-    <itemizedlist spacing="compact">
-      <listitem>
-        <para>
-          Required patch:
-          <ulink url="&patch-root;/mutter-&mutter-version;-upstream_fixes-1.patch"/>
-        </para>
-      </listitem>
-    </itemizedlist>
--->
+
     <bridgehead renderas="sect3">Mutter Dependencies</bridgehead>
 
     <bridgehead renderas="sect4">Required</bridgehead>
     <para role="required">
-      <!-- now using internal shipped clutter and cogl copies -->
-      <!-- <xref linkend="clutter"/>, -->
       <xref linkend="gnome-settings-daemon"/>,
       <xref linkend="graphene"/>,
       <xref linkend="libxcvt"/>,
-      <xref linkend="libxkbcommon"/>,
-      <xref linkend="pipewire"/>, and
-      <xref linkend="zenity"/>
+      <xref linkend="libxkbcommon"/>, and
+      <xref linkend="pipewire"/>
     </para>
 
@@ -123 +113 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional">
+      <xref linkend="python-dbusmock"/> (required for tests) and
       <xref linkend="xorg-server"/> (for X11 sessions)
     </para>
@@ -139 +130 @@
     <title>Installation of Mutter</title>
 
-<!--
-    <para>
-      First, fix a problem with the build system and bugs with wayland sessions:
-    </para>
-
-<screen><userinput remap="pre">patch -Np1 -i ../mutter-&mutter-version;-upstream_fixes-1.patch</userinput></screen>
--->
-
-    <para>
-      First, fix a race condition that sometimes occurs due to meson dependency
-      ordering:
-    </para>
-
-<screen><userinput remap="pre">sed -i '/libmutter_dep = declare_dependency(/a sources: mutter_built_sources,' src/meson.build</userinput></screen>
-
     <para>
       Install <application>Mutter</application> by running the following
@@ -162 +138 @@
 cd    build &amp;&amp;
 
-meson --prefix=/usr --buildtype=debugoptimized .. &amp;&amp;
+meson --prefix=/usr --buildtype=debugoptimized -Dtests=false .. &amp;&amp;
 ninja</userinput></screen>
 
+<!--
     <para>
       To test the results, issue:
@@ -173 +150 @@
       <filename>native-headless</filename>, is known to fail.
     </para>
+    -->
+    <!-- there are no added problems in sysv, AFAICT. Running the tests is
+    not easy whatever the init system. But using the instructions below in
+    a gnome session on sysv works (no test failure)...
+    <para revision='sysv'>
+       This package does not come with a test suite that runs properly in the
+       SystemV environment.
+    </para>
+    -->
+
+    <para>
+      The test suite requires debug functions to be enabled in the build, and an
+      external program called <command>xvfb-run</command>.  If you wish to run
+      the tests, you should download and install it before running
+      <command>meson</command>.
+
+      You can obtain it from <ulink
+      url="&sources-anduin-http;/mutter/xvfb-run">xvfb-run</ulink>, and install
+      it with executable permissions in <filename
+      class="directory">/usr/bin</filename>.  <command>xvfb-run</command> needs
+      <command>Xvfb</command> at runtime, and <command>Xvfb</command> can be
+      installed from either <xref linkend='xorg-server'/> or <xref
+      linkend='xwayland'/>.
+
+      You should also replace <parameter>-Dtests=false</parameter> in the
+      <command>meson</command> command, with
+      <parameter>-Dtests=true</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.
+    </para>
+
+    <para>
+      You can also test basic functions of <application>Mutter</application>
+      following <xref linkend='mutter-starting'/>, after installing it.
+    </para>
 
     <para>
@@ -180 +192 @@
 <screen role="root"><userinput>ninja install</userinput></screen>
 
+    <para>
+      The tests can now be run: issue
+      <command>ninja test</command>. The tests
+      require an active X or wayland session.
+      The <filename>native-unit</filename> test is known to fail.
+      A lot of tests will fail if the opengl rendering is not done in hardware.
+    </para>
   </sect2>
 
@@ -185 +204 @@
     <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.  The test suite of this package needs debug
-      to be enabled.
+      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"
+      href="../../xincludes/meson-buildtype-release.xml"/>
+-->
+    <para>
+      <parameter>-Dtests=false</parameter>: Prevents building the tests,
+      and removes a hard requirement on <command>xvfb-run</command>.
     </para>
 
@@ -197 +229 @@
       want meson to download <application>Sysprof</application> source
       code.
+    </para>
+
+  </sect2>
+
+  <sect2 role="starting" id="mutter-starting">
+    <title>Starting Mutter</title>
+
+    <!-- Mutter as a Wayland compositor Works with mutter-42.4 and 43.0.
+         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
+         such a configuration recently (I don't build Xorg Server or xinit
+         these days.  -->
+
+    <para>
+      <application>Mutter</application> is normally used as a component of
+      <application>gnome-shell</application>, but it can be used as a
+      standalone Wayland compositor too.  To run
+      <application>Mutter</application> as a Wayland compositor, in a
+      virtual console, issue:
+    </para>
+
+    <screen role='nodump'><userinput>mutter --wayland -- vte-2.91</userinput></screen>
+
+    <para>
+      Replace <command>vte-2.91</command> with the command line for the
+      first application you want in the Wayland session. Note that once this
+      application exits, the Wayland session will be terminated.
+    </para>
+
+    <para>
+      <application>Mutter</application> can also function as a nested
+      compositor in another Wayland session.  In a terminal emulator, issue:
+    </para>
+
+    <screen role='nodump'><userinput>MUTTER_DEBUG_DUMMY_MODE_SPECS=1920x1080 mutter --wayland --nested -- vte-2.91</userinput></screen>
+
+    <para>
+      Replace <replaceable>1920x1080</replaceable> with the size you want
+      for the nested Wayland session.
     </para>
   </sect2>
@@ -213 +284 @@
         </seg>
         <seg>
-          libmutter-8.so
+          libmutter-11.so
         </seg>
         <seg>
-          /usr/{lib,include,libexec/installed-tests,share/{installed-tests}}/mutter-8
+          /usr/{lib,include,libexec/installed-tests,share/{,installed-tests}}/mutter-11
         </seg>
       </seglistitem>
@@ -240 +311 @@
 
       <varlistentry id="libmutter">
-        <term><filename class="libraryfile">libmutter-8.so</filename></term>
+        <term><filename class="libraryfile">libmutter-11.so</filename></term>
         <listitem>
           <para>
@@ -246 +317 @@
           </para>
           <indexterm zone="mutter libmutter">
-            <primary sortas="c-libmutter">libmutter-8.so</primary>
+            <primary sortas="c-libmutter">libmutter-11.so</primary>
           </indexterm>
         </listitem>