Fix (improve) AO_REQUIRE_CAS description in README
authorIvan Maidanski <ivmai@mail.ru>
Wed, 2 Nov 2016 08:15:15 +0000 (11:15 +0300)
committerIvan Maidanski <ivmai@mail.ru>
Wed, 2 Nov 2016 23:25:08 +0000 (02:25 +0300)
* doc/README.txt: Document AO_REQUIRE_CAS better (replace
"compare-and-swap" with "AO_compare_and_swap*").

doc/README.txt

index 62b3946..b467a53 100644 (file)
@@ -25,9 +25,9 @@ by synthesis).  This is an attempt to replace various existing files with
 similar goals, since they usually do not handle differences in memory
 barrier styles with sufficient generality.
 
-If this is included after defining AO_REQUIRE_CAS, then the package
-will make an attempt to emulate compare-and-swap in a way that (at least
-on Linux) should still be async-signal-safe.  As a result, most other
+If this is included after defining AO_REQUIRE_CAS, then the package makes
+an attempt to emulate AO_compare_and_swap* (single-width) in a way that (at
+least on Linux) should still be async-signal-safe.  As a result, most other
 atomic operations will then be defined using the compare-and-swap
 emulation.  This emulation is slow, since it needs to disable signals.
 And it needs to block in case of contention.  If you care about performance