rcu: Reword help of RCU_TRACE option
PATCH 1/1 rcu: Reword help of RCU_TRACE option
Explicitly state that enabling RCU_TRACE enables more tracepoints and not just "additional tracing".
---
Hello Paul,
Following our latest conversation re. enabling RCU tracing I had to actually go and look into the code to see which option enables the additional tracepoints. I wasn't sure while reading the help of TRACE_RCU. So here is a patch which explicitly states that this enables additional tracepoints.
Apply it if you deem necessary it might be just me that thinks the description is not verbose enough.
lib/Kconfig.debug | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
lib/Kconfig.debug +2 -2
@@ -1429,8 +1429,8 @@ config RCU_TRACE depends on DEBUG_KERNEL select TRACE_CLOCK help - This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + This option enables additional tracepoints in RCU which present + stats in debugfs for debugging RCU implementation. Say Y here if you want to enable RCU tracing Say N if you are unsure.
Signature · 1 line
2.5.0
Quoted 26 lines · Nikolay Borisov
Explicitly state that enabling
RCU_TRACEenables more tracepoints and not just "additional tracing".Signed-off-by Nikolay Borisov <[email protected]>---
Hello Paul,
Following our latest conversation re. enabling RCU tracing I had to actually go and look into the code to see which option enables the additional tracepoints. I wasn't sure while reading the help of
TRACE_RCU. So here is a patch which explicitly states that this enables additional tracepoints.Apply it if you deem necessary it might be just me that thinks the description is not verbose enough.
lib/Kconfig.debug | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)lib/Kconfig.debug +0
-0
lib/Kconfig.debug config RCU_TRACE · line 1433
Quoted 7 lines
lib/Kconfig.debug +2
-2@@ -1429,8 +1429,8 @@ config RCU_TRACE depends on DEBUG_KERNEL select TRACE_CLOCK help - This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + This option enables additional tracepoints in RCU which present + stats in debugfs for debugging RCU implementation.
How about something like this?
This option provides tracing in RCU which presents stats in debugfs for debugging RCU implementation. It also enables additional tracepoints for ftrace-style event tracing.
Thanx, Paul
Quoted 6 lines
lib/Kconfig.debug +0
-0Say Y here if you want to enable RCU tracing Say N if you are unsure.Signature · 1 line
2.5.0
Quoted 37 lines · Paul E. McKenney
Quoted 26 lines · Nikolay Borisov
Explicitly state that enabling
RCU_TRACEenables more tracepoints and not just "additional tracing".Signed-off-by Nikolay Borisov <[email protected]>---
Hello Paul,
Following our latest conversation re. enabling RCU tracing I had to actually go and look into the code to see which option enables the additional tracepoints. I wasn't sure while reading the help of
TRACE_RCU. So here is a patch which explicitly states that this enables additional tracepoints.Apply it if you deem necessary it might be just me that thinks the description is not verbose enough.
lib/Kconfig.debug | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)lib/Kconfig.debug +0
-0lib/Kconfig.debug config RCU_TRACE · line 1433
Quoted 7 lines
lib/Kconfig.debug +2
-2@@ -1429,8 +1429,8 @@ config RCU_TRACE depends on DEBUG_KERNEL select TRACE_CLOCK help - This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + This option enables additional tracepoints in RCU which present + stats in debugfs for debugging RCU implementation.How about something like this?
Quoted 3 lines
This option provides tracing in RCU which presents stats in debugfs for debugging RCU implementation. It also enables additional tracepoints for ftrace-style event tracing.
So long as it's explicitly stated that it also enables tracepoints it's all fine by me. Apparently I'm not the only one who got confused. In a question re. CONFIG_RCU_TRACE here is what someone said on IRC:
"what's tracepoints do you mean? this option enables the additional statistics permanently."
Care to apply it with the revised wording or shall I resend?
Quoted 10 lines
Thanx, Paul
Quoted 6 lines
lib/Kconfig.debug +0
-0Say Y here if you want to enable RCU tracing Say N if you are unsure.Signature · 1 line
2.5.0
Quoted 44 lines · Nikolay Borisov
Quoted 37 lines · Paul E. McKenney
Quoted 26 lines · Nikolay Borisov
Explicitly state that enabling
RCU_TRACEenables more tracepoints and not just "additional tracing".Signed-off-by Nikolay Borisov <[email protected]>---
Hello Paul,
Following our latest conversation re. enabling RCU tracing I had to actually go and look into the code to see which option enables the additional tracepoints. I wasn't sure while reading the help of
TRACE_RCU. So here is a patch which explicitly states that this enables additional tracepoints.Apply it if you deem necessary it might be just me that thinks the description is not verbose enough.
lib/Kconfig.debug | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)lib/Kconfig.debug +0
-0lib/Kconfig.debug config RCU_TRACE · line 1433
Quoted 7 lines
lib/Kconfig.debug +2
-2@@ -1429,8 +1429,8 @@ config RCU_TRACE depends on DEBUG_KERNEL select TRACE_CLOCK help - This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + This option enables additional tracepoints in RCU which present + stats in debugfs for debugging RCU implementation.How about something like this?
Quoted 3 lines
This option provides tracing in RCU which presents stats in debugfs for debugging RCU implementation. It also enables additional tracepoints for ftrace-style event tracing.
Quoted 8 lines
So long as it's explicitly stated that it also enables tracepoints it's all fine by me. Apparently I'm not the only one who got confused. In a question re.
CONFIG_RCU_TRACEhere is what someone said on IRC:"what's tracepoints do you mean? this option enables the additional statistics permanently."
Care to apply it with the revised wording or shall I resend?
Please see below for the current state.
Thanx, Paul
------------------------------------------------------------------------
commit a30cd69bdcb1ae12cb243e75eddd608c1798d438
Author: Nikolay Borisov <[email protected]> Date: Thu Oct 6 05:42:39 2016 -0700
rcu: RCU_TRACE enables event tracing as well as debugfs
The commit brings the RCU_TRACE Kconfig option's help text up to date by noting that it enables additional event tracing as well as debugfs.
lib/Kconfig.debug +2 -1
@@ -1450,7 +1450,8 @@ config RCU_TRACE select TRACE_CLOCK help This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + in debugfs for debugging RCU implementation. It also enables + additional tracepoints for ftrace-style event tracing. Say Y here if you want to enable RCU tracing Say N if you are unsure.
Quoted 49 lines · Paul E. McKenney
Quoted 48 lines · Nikolay Borisov
Quoted 37 lines · Paul E. McKenney
Quoted 26 lines · Nikolay Borisov
Explicitly state that enabling
RCU_TRACEenables more tracepoints and not just "additional tracing".Signed-off-by Nikolay Borisov <[email protected]>---
Hello Paul,
Following our latest conversation re. enabling RCU tracing I had to actually go and look into the code to see which option enables the additional tracepoints. I wasn't sure while reading the help of
TRACE_RCU. So here is a patch which explicitly states that this enables additional tracepoints.Apply it if you deem necessary it might be just me that thinks the description is not verbose enough.
lib/Kconfig.debug | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)lib/Kconfig.debug +0
-0lib/Kconfig.debug config RCU_TRACE · line 1433
Quoted 7 lines
lib/Kconfig.debug +2
-2@@ -1429,8 +1429,8 @@ config RCU_TRACE depends on DEBUG_KERNEL select TRACE_CLOCK help - This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + This option enables additional tracepoints in RCU which present + stats in debugfs for debugging RCU implementation.How about something like this?
Quoted 3 lines
This option provides tracing in RCU which presents stats in debugfs for debugging RCU implementation. It also enables additional tracepoints for ftrace-style event tracing.
So long as it's explicitly stated that it also enables tracepoints it's all fine by me. Apparently I'm not the only one who got confused. In a question re.
CONFIG_RCU_TRACEhere is what someone said on IRC:
Quoted 8 lines
Quoted 4 lines
"what's tracepoints do you mean? this option enables the additional statistics permanently."
Care to apply it with the revised wording or shall I resend?
Please see below for the current state.
Thanx, Paul
Splendid, ACK.
Quoted 31 lines
------------------------------------------------------------------------
commit
a30cd69bdcb1ae12cb243e75eddd608c1798d438Author: Nikolay Borisov <[email protected]> Date: Thu Oct 6 05:42:39 2016 -0700rcu:
RCU_TRACEenables event tracing as well as debugfsThe commit brings the
RCU_TRACEKconfigoption's help text up to date by noting that it enables additional event tracing as well as debugfs.Signed-off-by Nikolay Borisov <[email protected]>[ paulmck: Do some wordsmithing. ]Signed-off-by Paul E. McKenney <[email protected]>lib/Kconfig.debug +2
-1@@ -1450,7 +1450,8 @@ config RCU_TRACE select TRACE_CLOCK help This option provides tracing in RCU which presents stats - in debugfs for debugging RCU implementation. + in debugfs for debugging RCU implementation. It also enables + additional tracepoints for ftrace-style event tracing. Say Y here if you want to enable RCU tracing Say N if you are unsure.