Minor language chages.
authorBenny Lyons <Benny.Lyons@gmx.net>
Sun, 15 Aug 2010 20:29:20 +0000 (22:29 +0200)
committerBenny Lyons <Benny.Lyons@gmx.net>
Sun, 15 Aug 2010 20:29:20 +0000 (22:29 +0200)
doc/resourcetracking.txt

index 2cd9576..8e26b44 100644 (file)
@@ -10,27 +10,27 @@ ALPHA builds.
 
 HEAD++ Concepts;;
 
-Resources are abstracted, NoBug has little knowledge about the semantics of a
-resource, it only keeps records of resources and the code using it and ensures
-basic constraints. Detailed usage checks of resource have to be done with other
-NoBug facilities.
+Resources are an abstract entity for NoBug, which has little knowledge about the
+semantics of a resource; it only keeps records of resources and the code using 
+these resources and ensures basic constraints. More detailed checks on resource 
+usage have to be done with other NoBug facilities.
 
-Resources are identified by a arbitrary identifier which is just a
+Resources are identified by an arbitrary identifier which is just a
 pointer. Additionally a name, the type and the source locations which
-announced the resource are stored.
+registered the resource are stored.
 
-Code which wants to use a resource calls a enter macro with its own identifier
-and state, then might alter the state and finally a leave macro when finished
-with it.
+Code which requiring to use a resource, calls an 'enter' macro, supplying 
+an identifier and state. The state can be altered. Thereafter a 'leave' macro is
+used when the the code is finished with the resources.
 
-When a resource is used one has to pass one of this states:
+When a resource is used, one has to pass one of these states:
 
   `NOBUG_RESOURCE_WAITING`::
-        For resources where acquisition could block (locks) you enter it with a
-        WAITING state first and as soon you acquired it you change the state to one
-        of the following.
+        For resources which might need to be blocked (locks),  enter with a
+        WAITING state first, as soon at the resource is acquired, change the 
+        state to one of the following.
   `NOBUG_RESOURCE_EXCLUSIVE`::
-        Acquired the resource exclusively. It must not be acquired
+        Acquired the resource exclusively. The resource must not be acquired
         again, not even from the same thread.
   `NOBUG_RESOURCE_RECURSIVE`::
         The resource might be entered multiple times from the same
@@ -71,6 +71,6 @@ strict digraph G
 HEAD== Notes;;
 
 The Resource Tracker relies on proper announce/forget and enter/leave
-are properly pairing. The programmer should ensure that this is done
-right, otherwise the results are unpredictable.
+are properly paired. The programmer should ensure that this is correctly 
+done, otherwise the results are unpredictable.