From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date: Fri, 23 Sep 2016 19:33:27 +0000 (-0300)
Subject: Documentation/volatile-considered-harmful.txt: convert to ReST markup
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=9c27d77d999491d6c80c570887dc95d32908cae5;p=GitHub%2Fmoto-9609%2Fandroid_kernel_motorola_exynos9610.git

Documentation/volatile-considered-harmful.txt: convert to ReST markup

- Fix document section markups;
- use quote blocks where needed;
- adjust spaces and blank lines;
- add it to the development-processs book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---

diff --git a/Documentation/volatile-considered-harmful.txt b/Documentation/volatile-considered-harmful.txt
index db0cb228d64a..e0d042af386c 100644
--- a/Documentation/volatile-considered-harmful.txt
+++ b/Documentation/volatile-considered-harmful.txt
@@ -22,7 +22,7 @@ need to use volatile as well.  If volatile is still necessary, there is
 almost certainly a bug in the code somewhere.  In properly-written kernel
 code, volatile can only serve to slow things down.
 
-Consider a typical block of kernel code:
+Consider a typical block of kernel code::
 
     spin_lock(&the_lock);
     do_something_on(&shared_data);
@@ -57,7 +57,7 @@ optimization, so, once again, volatile is unnecessary.
 
 Another situation where one might be tempted to use volatile is
 when the processor is busy-waiting on the value of a variable.  The right
-way to perform a busy wait is:
+way to perform a busy wait is::
 
     while (my_variable != what_i_want)
         cpu_relax();
@@ -103,17 +103,20 @@ they come with a justification which shows that the concurrency issues have
 been properly thought through.
 
 
-NOTES
------
+References
+==========
 
 [1] http://lwn.net/Articles/233481/
+
 [2] http://lwn.net/Articles/233482/
 
-CREDITS
--------
+Credits
+=======
 
 Original impetus and research by Randy Dunlap
+
 Written by Jonathan Corbet
+
 Improvements via comments from Satyam Sharma, Johannes Stezenbach, Jesper
-	Juhl, Heikki Orsila, H. Peter Anvin, Philipp Hahn, and Stefan
-	Richter.
+Juhl, Heikki Orsila, H. Peter Anvin, Philipp Hahn, and Stefan
+Richter.