Documentation/locking/atomic: Add documents for new atomic_t APIs
authorPeter Zijlstra <[email protected]>
Mon, 12 Jun 2017 12:50:27 +0000 (14:50 +0200)
committerIngo Molnar <[email protected]>
Thu, 10 Aug 2017 10:29:00 +0000 (12:29 +0200)
commit706eeb3e9c6f032f2d22a1c658624cfb6ace61d4
tree5739662f21de8b9619e83f95987a2f81cc369ee7
parent450f9689f294c331c56ec37d68302ccc19c7caa2
Documentation/locking/atomic: Add documents for new atomic_t APIs

Since we've vastly expanded the atomic_t interface in recent years the
existing documentation is woefully out of date and people seem to get
confused a bit.

Start a new document to hopefully better explain the current state of
affairs.

The old atomic_ops.txt also covers bitmaps and a few more details so
this is not a full replacement and we'll therefore keep that document
around until such a time that we've managed to write more text to cover
its entire.

Also please, ReST people, go away.

Signed-off-by: Peter Zijlstra (Intel) <[email protected]>
Cc: Boqun Feng <[email protected]>
Cc: Linus Torvalds <[email protected]>
Cc: Paul McKenney <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Cc: Randy Dunlap <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: Will Deacon <[email protected]>
Signed-off-by: Ingo Molnar <[email protected]>
Documentation/atomic_bitops.txt [new file with mode: 0644]
Documentation/atomic_t.txt [new file with mode: 0644]
Documentation/memory-barriers.txt