[tip:timers/core] timers: Adjust a kernel-doc comment

2018-05-13 Thread tip-bot for Mauro Carvalho Chehab
Commit-ID:  bf9c96bec76fbc4424b4c70be563af4107d8044f
Gitweb: https://git.kernel.org/tip/bf9c96bec76fbc4424b4c70be563af4107d8044f
Author: Mauro Carvalho Chehab 
AuthorDate: Mon, 7 May 2018 06:35:48 -0300
Committer:  Thomas Gleixner 
CommitDate: Sun, 13 May 2018 15:55:43 +0200

timers: Adjust a kernel-doc comment

Those three warnings can easily solved by using :: to indicate a
code block:

./kernel/time/timer.c:1259: WARNING: Unexpected indentation.
./kernel/time/timer.c:1261: WARNING: Unexpected indentation.
./kernel/time/timer.c:1262: WARNING: Block quote ends without a blank 
line; unexpected unindent.

While here, align the lines at the block.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Thomas Gleixner 
Cc: Jonathan Corbet 
Cc: Stephen Boyd 
Cc: Linux Doc Mailing List 
Cc: Mauro Carvalho Chehab 
Cc: John Stultz 
Link: 
https://lkml.kernel.org/r/f02e6a0ce27f3b5e33415d92d07a40598904b3ee.1525684985.git.mchehab%2bsams...@kernel.org

---
 kernel/time/timer.c | 14 +++---
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/kernel/time/timer.c b/kernel/time/timer.c
index 4a4fd567fb26..cc2d23e6ff61 100644
--- a/kernel/time/timer.c
+++ b/kernel/time/timer.c
@@ -1251,18 +1251,18 @@ EXPORT_SYMBOL(try_to_del_timer_sync);
  *
  * Note: For !irqsafe timers, you must not hold locks that are held in
  *   interrupt context while calling this function. Even if the lock has
- *   nothing to do with the timer in question.  Here's why:
+ *   nothing to do with the timer in question.  Here's why::
  *
  *CPU0 CPU1
  * 
- *   
- *   call_timer_fn();
- * base->running_timer = mytimer;
- *  spin_lock_irq(somelock);
+ * 
+ *   call_timer_fn();
+ *   base->running_timer = mytimer;
+ *spin_lock_irq(somelock);
  * 
  *spin_lock(somelock);
- *  del_timer_sync(mytimer);
- *   while (base->running_timer == mytimer);
+ *del_timer_sync(mytimer);
+ *while (base->running_timer == mytimer);
  *
  * Now del_timer_sync() will never return and never release somelock.
  * The interrupt on the other CPU is waiting to grab somelock but


[tip:timers/core] timers: Adjust a kernel-doc comment

2018-05-13 Thread tip-bot for Mauro Carvalho Chehab
Commit-ID:  bf9c96bec76fbc4424b4c70be563af4107d8044f
Gitweb: https://git.kernel.org/tip/bf9c96bec76fbc4424b4c70be563af4107d8044f
Author: Mauro Carvalho Chehab 
AuthorDate: Mon, 7 May 2018 06:35:48 -0300
Committer:  Thomas Gleixner 
CommitDate: Sun, 13 May 2018 15:55:43 +0200

timers: Adjust a kernel-doc comment

Those three warnings can easily solved by using :: to indicate a
code block:

./kernel/time/timer.c:1259: WARNING: Unexpected indentation.
./kernel/time/timer.c:1261: WARNING: Unexpected indentation.
./kernel/time/timer.c:1262: WARNING: Block quote ends without a blank 
line; unexpected unindent.

While here, align the lines at the block.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Thomas Gleixner 
Cc: Jonathan Corbet 
Cc: Stephen Boyd 
Cc: Linux Doc Mailing List 
Cc: Mauro Carvalho Chehab 
Cc: John Stultz 
Link: 
https://lkml.kernel.org/r/f02e6a0ce27f3b5e33415d92d07a40598904b3ee.1525684985.git.mchehab%2bsams...@kernel.org

---
 kernel/time/timer.c | 14 +++---
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/kernel/time/timer.c b/kernel/time/timer.c
index 4a4fd567fb26..cc2d23e6ff61 100644
--- a/kernel/time/timer.c
+++ b/kernel/time/timer.c
@@ -1251,18 +1251,18 @@ EXPORT_SYMBOL(try_to_del_timer_sync);
  *
  * Note: For !irqsafe timers, you must not hold locks that are held in
  *   interrupt context while calling this function. Even if the lock has
- *   nothing to do with the timer in question.  Here's why:
+ *   nothing to do with the timer in question.  Here's why::
  *
  *CPU0 CPU1
  * 
- *   
- *   call_timer_fn();
- * base->running_timer = mytimer;
- *  spin_lock_irq(somelock);
+ * 
+ *   call_timer_fn();
+ *   base->running_timer = mytimer;
+ *spin_lock_irq(somelock);
  * 
  *spin_lock(somelock);
- *  del_timer_sync(mytimer);
- *   while (base->running_timer == mytimer);
+ *del_timer_sync(mytimer);
+ *while (base->running_timer == mytimer);
  *
  * Now del_timer_sync() will never return and never release somelock.
  * The interrupt on the other CPU is waiting to grab somelock but