documentation: Fix relation between nohz_full and rcu_nocbs
authorPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Fri, 2 Jun 2017 18:26:43 +0000 (11:26 -0700)
committerPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Mon, 24 Jul 2017 23:00:15 +0000 (16:00 -0700)
If a CPU is specified in the nohz_full= kernel boot parameter to a
kernel built with CONFIG_NO_HZ_FULL=y, then that CPU's callbacks will
be offloaded, just as if that CPU had also been specified in the
rcu_nocbs= kernel boot parameter.  But the current documentation
states that the user must keep these two boot parameters manually
synchronized.  This commit therefore updates the documentation to
reflect reality.

Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Documentation/admin-guide/kernel-parameters.txt

index d9c171ce4190845950e7c14e362265b4d26adc74..3a99cc96b6b15414509c6ad92511dfbd9f4047f6 100644 (file)
                        In kernels built with CONFIG_NO_HZ_FULL=y, set
                        the specified list of CPUs whose tick will be stopped
                        whenever possible. The boot CPU will be forced outside
-                       the range to maintain the timekeeping.
-                       The CPUs in this range must also be included in the
-                       rcu_nocbs= set.
+                       the range to maintain the timekeeping.  Any CPUs
+                       in this list will have their RCU callbacks offloaded,
+                       just as if they had also been called out in the
+                       rcu_nocbs= boot parameter.
 
        noiotrap        [SH] Disables trapped I/O port accesses.