From: Jean Delvare <jdelvare@suse.de>
To: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Cc: LKML <linux-kernel@vger.kernel.org>
Subject: config RCU_EQS_DEBUG
Date: Fri, 3 Jul 2015 10:07:45 +0200 [thread overview]
Message-ID: <20150703100745.7993f403@endymion.delvare> (raw)
Hi Paul,
You just introduced a Linux kernel configuration option named
RCU_EQS_DEBUG. Its short description is "Use this when adding any sort
of NO_HZ support to your arch".
I'm afraid this is a bad way to briefly explain what the option
actually does (which is what the short description is for.) A sentence
like "use this when adding any sort of NO_HZ support to your arch"
should go in the help text, not the short description. The short
description should be something like along the lines of "Enable
consistency checks for RCU", for example.
Additionally I see some inconsistency in the fact that this option
defaults to n but the help text says "Say Y if you are unsure". BTW,
option RCU_CPU_STALL_INFO is equally inconsistent with a default y and
"say N if you are unsure" in the help text.
--
Jean Delvare
SUSE L3 Support
next reply other threads:[~2015-07-03 8:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-07-03 8:07 Jean Delvare [this message]
2015-07-03 16:00 ` config RCU_EQS_DEBUG Paul E. McKenney
2015-07-04 16:53 ` Jean Delvare
2015-07-05 4:20 ` Paul E. McKenney
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20150703100745.7993f403@endymion.delvare \
--to=jdelvare@suse.de \
--cc=linux-kernel@vger.kernel.org \
--cc=paulmck@linux.vnet.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox