Commit 5e013dc1 authored by Zhen Lei's avatar Zhen Lei Committed by Paul E. McKenney
Browse files

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/20221123163255.48653674@canb.auug.org.au/


Fixes: 3d2788ba4573 ("doc: Document CONFIG_RCU_CPU_STALL_CPUTIME=y stall information")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarZhen Lei <thunder.leizhen@huawei.com>
Tested-by: default avatarAkira Yokosawa <akiyks@gmail.com>
Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
parent eff86459

Documentation/RCU/stallwarn.rst

+30 −26
Original line number Diff line number Diff line
@@ -412,18 +412,20 @@ in milliseconds. Because user-mode tasks normally do not cause RCU CPU 
stalls, these tasks are typically kernel tasks, which is why only the

system CPU time are considered.



The sampling period is shown as follows:

:<------------first timeout---------->:<-----second timeout----->:

:<--half timeout-->:<--half timeout-->:                          :

:                  :<--first period-->:                          :

:                  :<-----------second sampling period---------->:

:                  :                  :                          :

:          snapshot time point    1st-stall                  2nd-stall

The sampling period is shown as follows::



  |<------------first timeout---------->|<-----second timeout----->|

  |<--half timeout-->|<--half timeout-->|                          |

  |                  |<--first period-->|                          |

  |                  |<-----------second sampling period---------->|

  |                  |                  |                          |

             snapshot time point    1st-stall                  2nd-stall



The following describes four typical scenarios:



1. A CPU looping with interrupts disabled.::

1. A CPU looping with interrupts disabled.



   ::



     rcu:          hardirqs   softirqs   csw/system

     rcu:  number:        0          0            0
@@ -440,7 +442,7 @@ The following describes four typical scenarios: 


   This is similar to the previous example, but with non-zero number of

   and CPU time consumed by hard interrupts, along with non-zero CPU

   time consumed by in-kernel execution.::

   time consumed by in-kernel execution::



     rcu:          hardirqs   softirqs   csw/system

     rcu:  number:      624          0            0
@@ -454,7 +456,7 @@ The following describes four typical scenarios: 


3. A CPU looping with preemption disabled.



   Here, only the number of context switches is zero.::

   Here, only the number of context switches is zero::



     rcu:          hardirqs   softirqs   csw/system

     rcu:  number:      624         45            0
@@ -463,7 +465,9 @@ The following describes four typical scenarios: 
   This situation hints that the stalled CPU was looping with preemption

   disabled.



4. No looping, but massive hard and soft interrupts.::

4. No looping, but massive hard and soft interrupts.



   ::



     rcu:          hardirqs   softirqs   csw/system

     rcu:  number:       xx         xx            0