summary refs log tree commit diff
path: root/nixos/modules
diff options
context:
space:
mode:
authorBjørn Forsman <bjorn.forsman@gmail.com>2014-02-09 13:43:12 +0100
committerBjørn Forsman <bjorn.forsman@gmail.com>2014-02-09 13:56:09 +0100
commit48851fa749d634d68eaaa0dcd6c4041615b6c0f0 (patch)
tree08c667a6202a7470b99cbf036885f6d1b669eaa0 /nixos/modules
parentcba2444d11ca4d2a8a335a752568c5fe09a90390 (diff)
downloadnixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.tar
nixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.tar.gz
nixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.tar.bz2
nixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.tar.lz
nixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.tar.xz
nixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.tar.zst
nixlib-48851fa749d634d68eaaa0dcd6c4041615b6c0f0.zip
nixos/memtest: use docbook formatting
Without this the HTML manual and manpage is quite unreadable (newlines
are squashed so it doesn't look like a list anymore).

(Unfortunately, this makes the source unreadable.)
Diffstat (limited to 'nixos/modules')
-rw-r--r--nixos/modules/system/boot/loader/grub/memtest.nix44
1 files changed, 38 insertions, 6 deletions
diff --git a/nixos/modules/system/boot/loader/grub/memtest.nix b/nixos/modules/system/boot/loader/grub/memtest.nix
index 3745b4057126..2461d1f80c78 100644
--- a/nixos/modules/system/boot/loader/grub/memtest.nix
+++ b/nixos/modules/system/boot/loader/grub/memtest.nix
@@ -32,12 +32,44 @@ in
           Parameters added to the Memtest86+ command line. As of memtest86+ 5.01
           the following list of (apparently undocumented) parameters are
           accepted:
-            console=... -- set up a serial console.
-            btrace      -- enable boot trace.
-            maxcpus=... -- limit number of CPUs.
-            onepass     -- run one pass and exit if there are no errors.
-            tstlist=... -- list of tests to run.
-            cpumask=... -- set a CPU mask, to select CPUs to use for testing.
+
+          <itemizedlist>
+
+          <listitem>
+            <para><literal>console=...</literal>, set up a serial console.
+            Examples:
+            <literal>console=ttyS0</literal>,
+            <literal>console=ttyS0,9600</literal> or
+            <literal>console=ttyS0,115200n8</literal>.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>btrace</literal>, enable boot trace.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>maxcpus=N</literal>, limit number of CPUs.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>onepass</literal>, run one pass and exit if there
+            are no errors.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>tstlist=...</literal>, list of tests to run.
+            Example: <literal>0,1,2</literal>.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>cpumask=...</literal>, set a CPU mask, to select CPUs
+            to use for testing.</para>
+          </listitem>
+
+          </itemizedlist>
+
+          This list of command line options was obtained by reading the
+          Memtest86+ source code.
         '';
       };