Skip to content

Commit 5e013dc

Browse files
Zhen Leipaulmckrcu
authored andcommitted
doc: Fix htmldocs build warnings of stallwarn.rst
Documentation/RCU/stallwarn.rst: 401: WARNING: Literal block expected; none found. 428: WARNING: Literal block expected; none found. 445: WARNING: Literal block expected; none found. 459: WARNING: Literal block expected; none found. 468: WARNING: Literal block expected; none found. The literal block needs to be indented, so this commit adds two spaces to each line. In addition, ':', which is used as a boundary in the literal block, is replaced by '|'. Link: https://lore.kernel.org/linux-next/[email protected]/ Fixes: 3d2788b ("doc: Document CONFIG_RCU_CPU_STALL_CPUTIME=y stall information") Reported-by: Stephen Rothwell <[email protected]> Signed-off-by: Zhen Lei <[email protected]> Tested-by: Akira Yokosawa <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent eff8645 commit 5e013dc

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

Documentation/RCU/stallwarn.rst

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -398,9 +398,9 @@ In kernels built with CONFIG_RCU_CPU_STALL_CPUTIME=y or booted with
398398
rcupdate.rcu_cpu_stall_cputime=1, the following additional information
399399
is supplied with each RCU CPU stall warning::
400400

401-
rcu: hardirqs softirqs csw/system
402-
rcu: number: 624 45 0
403-
rcu: cputime: 69 1 2425 ==> 2500(ms)
401+
rcu: hardirqs softirqs csw/system
402+
rcu: number: 624 45 0
403+
rcu: cputime: 69 1 2425 ==> 2500(ms)
404404

405405
These statistics are collected during the sampling period. The values
406406
in row "number:" are the number of hard interrupts, number of soft
@@ -412,22 +412,24 @@ in milliseconds. Because user-mode tasks normally do not cause RCU CPU
412412
stalls, these tasks are typically kernel tasks, which is why only the
413413
system CPU time are considered.
414414

415-
The sampling period is shown as follows:
416-
:<------------first timeout---------->:<-----second timeout----->:
417-
:<--half timeout-->:<--half timeout-->: :
418-
: :<--first period-->: :
419-
: :<-----------second sampling period---------->:
420-
: : : :
421-
: snapshot time point 1st-stall 2nd-stall
415+
The sampling period is shown as follows::
422416

417+
|<------------first timeout---------->|<-----second timeout----->|
418+
|<--half timeout-->|<--half timeout-->| |
419+
| |<--first period-->| |
420+
| |<-----------second sampling period---------->|
421+
| | | |
422+
snapshot time point 1st-stall 2nd-stall
423423

424424
The following describes four typical scenarios:
425425

426-
1. A CPU looping with interrupts disabled.::
426+
1. A CPU looping with interrupts disabled.
427427

428-
rcu: hardirqs softirqs csw/system
429-
rcu: number: 0 0 0
430-
rcu: cputime: 0 0 0 ==> 2500(ms)
428+
::
429+
430+
rcu: hardirqs softirqs csw/system
431+
rcu: number: 0 0 0
432+
rcu: cputime: 0 0 0 ==> 2500(ms)
431433

432434
Because interrupts have been disabled throughout the measurement
433435
interval, there are no interrupts and no context switches.
@@ -440,11 +442,11 @@ The following describes four typical scenarios:
440442

441443
This is similar to the previous example, but with non-zero number of
442444
and CPU time consumed by hard interrupts, along with non-zero CPU
443-
time consumed by in-kernel execution.::
445+
time consumed by in-kernel execution::
444446

445-
rcu: hardirqs softirqs csw/system
446-
rcu: number: 624 0 0
447-
rcu: cputime: 49 0 2446 ==> 2500(ms)
447+
rcu: hardirqs softirqs csw/system
448+
rcu: number: 624 0 0
449+
rcu: cputime: 49 0 2446 ==> 2500(ms)
448450

449451
The fact that there are zero softirqs gives a hint that these were
450452
disabled, perhaps via local_bh_disable(). It is of course possible
@@ -454,20 +456,22 @@ The following describes four typical scenarios:
454456

455457
3. A CPU looping with preemption disabled.
456458

457-
Here, only the number of context switches is zero.::
459+
Here, only the number of context switches is zero::
458460

459-
rcu: hardirqs softirqs csw/system
460-
rcu: number: 624 45 0
461-
rcu: cputime: 69 1 2425 ==> 2500(ms)
461+
rcu: hardirqs softirqs csw/system
462+
rcu: number: 624 45 0
463+
rcu: cputime: 69 1 2425 ==> 2500(ms)
462464

463465
This situation hints that the stalled CPU was looping with preemption
464466
disabled.
465467

466-
4. No looping, but massive hard and soft interrupts.::
468+
4. No looping, but massive hard and soft interrupts.
469+
470+
::
467471

468-
rcu: hardirqs softirqs csw/system
469-
rcu: number: xx xx 0
470-
rcu: cputime: xx xx 0 ==> 2500(ms)
472+
rcu: hardirqs softirqs csw/system
473+
rcu: number: xx xx 0
474+
rcu: cputime: xx xx 0 ==> 2500(ms)
471475

472476
Here, the number and CPU time of hard interrupts are all non-zero,
473477
but the number of context switches and the in-kernel CPU time consumed

0 commit comments

Comments
 (0)