From: Julian Seward <jseward@acm.org>
Date: Tue, 8 Nov 2005 15:52:36 +0000 (+0000)
Subject: Document the --kernel-variant= option.
X-Git-Tag: svn/VALGRIND_3_1_0~192
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=31f1119c9dd42617fd92faf2ddd9e1724e713b6c;p=thirdparty%2Fvalgrind.git

Document the --kernel-variant= option.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5040
---

diff --git a/coregrind/m_main.c b/coregrind/m_main.c
index e7d0c70dc7..4be1644d85 100644
--- a/coregrind/m_main.c
+++ b/coregrind/m_main.c
@@ -884,6 +884,8 @@ static void usage_NORETURN ( Bool debug_help )
 "    --show-emwarns=no|yes     show warnings about emulation limits? [no]\n"
 "    --smc-check=none|stack|all  checks for self-modifying code: none,\n"
 "                              only for code found in stacks, or all [stack]\n"
+"    --kernel-variant=variant1,variant2,...  known variants: bproc [none]\n"
+"                              handle non-standard kernel variants\n"
 "\n"
 "  user options for Valgrind tools that report errors:\n"
 "    --xml=yes                 all output is in XML (Memcheck/Nulgrind only)\n"
diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml
index d3fd4b8c0c..f1a3401958 100644
--- a/docs/xml/manual-core.xml
+++ b/docs/xml/manual-core.xml
@@ -1034,6 +1034,26 @@ Addrcheck), the following options apply.</para>
     </itemizedlist>
    </listitem>
 
+   <listitem id="kernel_variant">
+    <para><computeroutput>--kernel-variant=variant1,variant2,...</computeroutput>
+    </para>
+    <para>Handle system calls and ioctls arising from minor variants
+    of the default kernel for this platform.  This is useful for
+    running on hacked kernels or with kernel modules which support
+    nonstandard ioctls, for example.  Use with caution.  If you don't
+    understand what this option does then you almost certainly don't
+    need it.
+    Currently known variants are:</para>
+    <itemizedlist>
+     <listitem><para><computeroutput>bproc</computeroutput></para>
+      <para>Support the sys_broc system call on x86.  This is for
+      running on BProc, which is a minor variant of standard Linux
+      which is sometimes used for building clusters.
+      </para>
+     </listitem>
+    </itemizedlist>
+   </listitem>
+
    <listitem id="show_emwarns">
     <para><computeroutput>--show-emwarns=no</computeroutput> [default]</para>
     <para><computeroutput>--show-emwarns=yes</computeroutput></para>
diff --git a/none/tests/cmdline1.stdout.exp b/none/tests/cmdline1.stdout.exp
index 8f9b380dad..6263bdc7e7 100644
--- a/none/tests/cmdline1.stdout.exp
+++ b/none/tests/cmdline1.stdout.exp
@@ -23,6 +23,8 @@ usage: valgrind --tool=<toolname> [options] prog-and-args
     --show-emwarns=no|yes     show warnings about emulation limits? [no]
     --smc-check=none|stack|all  checks for self-modifying code: none,
                               only for code found in stacks, or all [stack]
+    --kernel-variant=variant1,variant2,...  known variants: bproc [none]
+                              handle non-standard kernel variants
 
   user options for Valgrind tools that report errors:
     --xml=yes                 all output is in XML (Memcheck/Nulgrind only)
diff --git a/none/tests/cmdline2.stdout.exp b/none/tests/cmdline2.stdout.exp
index db8349fd69..d686f75cce 100644
--- a/none/tests/cmdline2.stdout.exp
+++ b/none/tests/cmdline2.stdout.exp
@@ -23,6 +23,8 @@ usage: valgrind --tool=<toolname> [options] prog-and-args
     --show-emwarns=no|yes     show warnings about emulation limits? [no]
     --smc-check=none|stack|all  checks for self-modifying code: none,
                               only for code found in stacks, or all [stack]
+    --kernel-variant=variant1,variant2,...  known variants: bproc [none]
+                              handle non-standard kernel variants
 
   user options for Valgrind tools that report errors:
     --xml=yes                 all output is in XML (Memcheck/Nulgrind only)