fix resourcetracking formatting
authorChristian Thaeter <ct@pipapo.org>
Mon, 9 Aug 2010 07:41:13 +0000 (09:41 +0200)
committerChristian Thaeter <ct@pipapo.org>
Mon, 9 Aug 2010 07:41:13 +0000 (09:41 +0200)
doc/resourcetracking.txt

index be34f3c..2cd9576 100644 (file)
@@ -25,23 +25,23 @@ with it.
 
 When a resource is used one has to pass one of this states:
 
-  * NOBUG_RESOURCE_WAITING
-      + For resources where acquisition could block (locks) you enter it with a
+  `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.
-  * NOBUG_RESOURCE_EXCLUSIVE
-      + Acquired the resource exclusively. It must not be acquired
+  `NOBUG_RESOURCE_EXCLUSIVE`::
+        Acquired the resource exclusively. It must not be acquired
         again, not even from the same thread.
-  * NOBUG_RESOURCE_RECURSIVE
-      + The resource might be entered multiple times from the same
+  `NOBUG_RESOURCE_RECURSIVE`::
+        The resource might be entered multiple times from the same
         thread with this state.
-  * NOBUG_RESOURCE_SHARED
-      + The resource might be entered multiple times from any thread
+  `NOBUG_RESOURCE_SHARED`::
+        The resource might be entered multiple times from any thread
         with this state.
 
 Possible state transitions:
 
-["graphviz", "resource-transistinons.png"]
+["graphviz", "resource-transitions.eps"]
 ---------------------------------------------------------------------
 strict digraph G
 {
@@ -70,10 +70,6 @@ strict digraph G
 
 HEAD== Notes;;
 
-There are small race conditions between logging and checking resource tracking
-and the actual call to the resource using function. This is a design decision
-there is no way to account for this exactly when the function call may block.
-
 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.