]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/testsuite.html
save docs for 4.9
[i3/i3.github.io] / docs / testsuite.html
index ca7b75f893220e121cdc86c5668c057e73a0c63a..7897170733faf564363ab4694ee25136a0c1e13d 100644 (file)
@@ -2,9 +2,9 @@
     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
-<link rel="icon" type="image/png" href="/favicon.png">\r
+<link rel="icon" type="image/x-icon" href="/favicon.ico">\r
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.9" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
 <title>i3: i3 testsuite</title>\r
 <link rel="stylesheet" href="/css/style.css" type="text/css" />\r
 <link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
@@ -138,6 +138,8 @@ to install all of them.</p></div>
 client, simply called <tt>cpan</tt>. It comes with every Perl installation and can be\r
 used to install the testsuite. Many users prefer to use the more modern\r
 <tt>cpanminus</tt> instead, though (because it asks no questions and just works):</p></div>\r
+<div class="paragraph"><p>The tests additionally require <tt>Xephyr(1)</tt> to run a nested X server. Install\r
+<tt>xserver-xephyr</tt> on Debian or <tt>xorg-xserver-xephyr</tt> on Arch Linux.</p></div>\r
 <div class="listingblock">\r
 <div class="title">Installing testsuite dependencies using cpanminus (preferred)</div>\r
 <div class="content">\r
@@ -165,7 +167,11 @@ more testcases. Also, it takes care of starting up a separate instance of i3
 with an appropriate configuration file and creates a folder for each run\r
 containing the appropriate i3 logfile for each testcase. The latest folder can\r
 always be found under the symlink <tt>latest/</tt>. Unless told differently, it will\r
-run the tests on a separate X server instance (using the Xdummy script).</p></div>\r
+run the tests on a separate X server instance (using Xephyr).</p></div>\r
+<div class="paragraph"><p>Xephyr will open a window where you can inspect the running test. You can run\r
+the tests without an X session with Xvfb, such as with <tt>xvfb-run\r
+./complete-run</tt>. This will also speed up the tests signficantly especially on\r
+machines without a powerful video card.</p></div>\r
 <div class="listingblock">\r
 <div class="title">Example invocation of complete-run.pl+</div>\r
 <div class="content">\r
@@ -208,11 +214,10 @@ $ less latest/i3-log-for-04-floating.t</tt></pre>
 <div class="paragraph"><p>If your attempt to run the tests with a bare call to ./complete-run.pl fails, try this:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>$ ./complete-run.pl --parallel=1 --keep-xdummy-output</tt></pre>\r
+<pre><tt>$ ./complete-run.pl --parallel=1 --keep-xserver-output</tt></pre>\r
 </div></div>\r
-<div class="paragraph"><p>One common cause of failures is not having the X dummy server module\r
-installed.  Under Debian and Ubuntu this is the package\r
-<tt>xserver-xorg-video-dummy</tt>.</p></div>\r
+<div class="paragraph"><p>This will show the output of Xephyr, which is the X server implementation we\r
+use for testing.</p></div>\r
 </div>\r
 <div class="sect3">\r
 <h4 id="_ipc_interface">3.2.2. IPC interface</h4>\r
@@ -236,10 +241,9 @@ manager.</p></div>
 <div class="sect2">\r
 <h3 id="_filesystem_structure">3.3. Filesystem structure</h3>\r
 <div class="paragraph"><p>In the git root of i3, the testcases live in the folder <tt>testcases</tt>. This\r
-folder contains the <tt>complete-run.pl</tt> and <tt>Xdummy</tt> scripts and a base\r
-configuration file which will be used for the tests. The different testcases\r
-(their file extension is .t, not .pl) themselves can be found in the\r
-conventionally named subfolder <tt>t</tt>:</p></div>\r
+folder contains the <tt>complete-run.pl</tt> and a base configuration file which will\r
+be used for the tests. The different testcases (their file extension is .t, not\r
+.pl) themselves can be found in the conventionally named subfolder <tt>t</tt>:</p></div>\r
 <div class="listingblock">\r
 <div class="title">Filesystem structure</div>\r
 <div class="content">\r
@@ -257,8 +261,7 @@ conventionally named subfolder <tt>t</tt>:</p></div>
 │   │   ├── ...\r
 │   │   ├── omitted for brevity\r
 │   │   ├── ...\r
-│   │   └── 74-regress-focus-toggle.t\r
-│   └── Xdummy</tt></pre>\r
+│   │   └── 74-regress-focus-toggle.t</tt></pre>\r
 </div></div>\r
 </div>\r
 </div>\r