Skip to content

Commit

Permalink
Documentation/volatile-considered-harmful.txt: convert to ReST markup
Browse files Browse the repository at this point in the history
- 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>
  • Loading branch information
mchehab committed Oct 24, 2016
1 parent 27641b9 commit 9c27d77
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions Documentation/volatile-considered-harmful.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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.

0 comments on commit 9c27d77

Please sign in to comment.