[PATCH] rcutorture: Remove outdated config option description

[PATCH] rcutorture: Remove outdated config option description

[SeongJae Park]

CONFIG_RCU_TORTURE_TEST_RUNNABLE has removed by commit 4e9a073f60367
("torture: Remove CONFIG_RCU_TORTURE_TEST_RUNNABLE, simplify code")
entirely but the document has not updated.  This commit updates the
document to remove the description for the config option and adding a
description for the alternative module parameter.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 Documentation/RCU/torture.txt | 20 +++++---------------
 1 file changed, 5 insertions(+), 15 deletions(-)

diff --git a/Documentation/RCU/torture.txt b/Documentation/RCU/torture.txt
index 118e7c1..4bd9d86 100644
--- a/Documentation/RCU/torture.txt
+++ b/Documentation/RCU/torture.txt
@@ -10,21 +10,6 @@ status messages via printk(), which can be examined via the dmesg
 command (perhaps grepping for "torture").  The test is started
 when the module is loaded, and stops when the module is unloaded.
 
-CONFIG_RCU_TORTURE_TEST_RUNNABLE
-
-It is also possible to specify CONFIG_RCU_TORTURE_TEST=y, which will
-result in the tests being loaded into the base kernel.  In this case,
-the CONFIG_RCU_TORTURE_TEST_RUNNABLE config option is used to specify
-whether the RCU torture tests are to be started immediately during
-boot or whether the /proc/sys/kernel/rcutorture_runnable file is used
-to enable them.  This /proc file can be used to repeatedly pause and
-restart the tests, regardless of the initial state specified by the
-CONFIG_RCU_TORTURE_TEST_RUNNABLE config option.
-
-You will normally -not- want to start the RCU torture tests during boot
-(and thus the default is CONFIG_RCU_TORTURE_TEST_RUNNABLE=n), but doing
-this can sometimes be useful in finding boot-time bugs.
-
 
 MODULE PARAMETERS
 
@@ -164,6 +149,11 @@ test_no_idle_hz	Whether or not to test the ability of RCU to operate in
 		idle CPUs.  Boolean parameter, "1" to test, "0" otherwise.
 		Defaults to omitting this test.
 
+torture_runnable  Start rcutorture at boot time in the case where the
+		  module is built into the kernel, otherwise wait for
+		  torture_runnable to be set via sysfs before starting.
+		  By default it will begin once the module is loaded.
+
 torture_type	The type of RCU to test, with string values as follows:
 
 		"rcu":  rcu_read_lock(), rcu_read_unlock() and call_rcu(),
-- 
1.9.1

Re: [PATCH] rcutorture: Remove outdated config option description

[Paul E. McKenney]

On Mon, Jun 20, 2016 at 07:51:22AM +0900, SeongJae Park wrote:
> CONFIG_RCU_TORTURE_TEST_RUNNABLE has removed by commit 4e9a073f60367
> ("torture: Remove CONFIG_RCU_TORTURE_TEST_RUNNABLE, simplify code")
> entirely but the document has not updated.  This commit updates the
> document to remove the description for the config option and adding a
> description for the alternative module parameter.
> 
> Signed-off-by: SeongJae Park <sj38.park@gmail.com>

Good catch on CONFIG_RCU_TORTURE_TEST_RUNNABLE, queued for testing and
review.

I had to drop the other hunk for torture_runnable, though.  This
capability is instead controlled by several parameters that are documented
in Documentation/kernel-parameters.txt.

							Thanx, Paul

> ---
>  Documentation/RCU/torture.txt | 20 +++++---------------
>  1 file changed, 5 insertions(+), 15 deletions(-)
> 
> diff --git a/Documentation/RCU/torture.txt b/Documentation/RCU/torture.txt
> index 118e7c1..4bd9d86 100644
> --- a/Documentation/RCU/torture.txt
> +++ b/Documentation/RCU/torture.txt
> @@ -10,21 +10,6 @@ status messages via printk(), which can be examined via the dmesg
>  command (perhaps grepping for "torture").  The test is started
>  when the module is loaded, and stops when the module is unloaded.
> 
> -CONFIG_RCU_TORTURE_TEST_RUNNABLE
> -
> -It is also possible to specify CONFIG_RCU_TORTURE_TEST=y, which will
> -result in the tests being loaded into the base kernel.  In this case,
> -the CONFIG_RCU_TORTURE_TEST_RUNNABLE config option is used to specify
> -whether the RCU torture tests are to be started immediately during
> -boot or whether the /proc/sys/kernel/rcutorture_runnable file is used
> -to enable them.  This /proc file can be used to repeatedly pause and
> -restart the tests, regardless of the initial state specified by the
> -CONFIG_RCU_TORTURE_TEST_RUNNABLE config option.
> -
> -You will normally -not- want to start the RCU torture tests during boot
> -(and thus the default is CONFIG_RCU_TORTURE_TEST_RUNNABLE=n), but doing
> -this can sometimes be useful in finding boot-time bugs.
> -
> 
>  MODULE PARAMETERS
> 
> @@ -164,6 +149,11 @@ test_no_idle_hz	Whether or not to test the ability of RCU to operate in
>  		idle CPUs.  Boolean parameter, "1" to test, "0" otherwise.
>  		Defaults to omitting this test.
> 
> +torture_runnable  Start rcutorture at boot time in the case where the
> +		  module is built into the kernel, otherwise wait for
> +		  torture_runnable to be set via sysfs before starting.
> +		  By default it will begin once the module is loaded.
> +
>  torture_type	The type of RCU to test, with string values as follows:
> 
>  		"rcu":  rcu_read_lock(), rcu_read_unlock() and call_rcu(),
> -- 
> 1.9.1
>