formatting improvments on the resourcetracker doc
authorChristian Thaeter <ct@pipapo.org>
Mon, 9 Aug 2010 08:01:14 +0000 (10:01 +0200)
committerChristian Thaeter <ct@pipapo.org>
Mon, 9 Aug 2010 08:01:14 +0000 (10:01 +0200)
src/nobug.h

index 92292b9..9dc3fa9 100644 (file)
@@ -1189,10 +1189,10 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros  `name`::
 //resourcemacros      identifer to be used for the handle
 //resourcemacros
-//resourcemacros There are two kinds of handles, each resource itself is abstracted with a
-//resourcemacros `RESOURCE_HANDLE` and every access to this resources is tracked through a
-//resourcemacros `RESOURCE_USER` handle. These macros takes care that the declaration is optimized
-//resourcemacros out in the same manner as the rest of the resource tracker would be disabled.
+//resourcemacros There are two kinds of handles. Resource themself are abstracted with a
+//resourcemacros `RESOURCE_HANDLE` while uses of a resources are tracked by `RESOURCE_USER`
+//resourcemacros handle. These macros takes care that the declaration is optimized out
+//resourcemacros in the same manner as the rest of the resource tracker would be disabled.
 //resourcemacros You can still instantiate handles as `struct nobug_resource_record*` or
 //resourcemacros `struct nobug_resource_user*` in structures which must have a constant size
 //resourcemacros unconditional of the build level. The two `*_INIT` macros can be used to initialize
@@ -1214,7 +1214,8 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros PARA RESOURCE_ANNOUNCE; RESOURCE_ANNOUNCE; publish new resources
 //resourcemacros  RESOURCE_ANNOUNCE(flag, type, name, identifier, handle)
 //resourcemacros  NOBUG_RESOURCE_ANNOUNCE_RAW(flagptr, type, name, ptr, handle)
-//resourcemacros  NOBUG_RESOURCE_ANNOUNCE_RAW_CTX(flagptr, type, name, ptr, handle, context)
+//resourcemacros  NOBUG_RESOURCE_ANNOUNCE_RAW_CTX(flagptr, type, name,
+//resourcemacros                                  ptr, handle, context)
 //resourcemacros
 //resourcemacros Publishes resources.
 //resourcemacros
@@ -1399,7 +1400,8 @@ NOTREACHED      abort           abort           nothing
 /*
 //resourcemacros PARA RESOURCE_ENTER; RESOURCE_ENTER; claim a resource
 //resourcemacros  RESOURCE_ENTER(flag, announced, user, state, handle)
-//resourcemacros  NOBUG_RESOURCE_ENTER_CTX(flag, resource, user, state, handle, context)
+//resourcemacros  NOBUG_RESOURCE_ENTER_CTX(flag, resource, user, state,
+//resourcemacros                           handle, context)
 //resourcemacros
 //resourcemacros Acquire a resource.
 //resourcemacros
@@ -1410,13 +1412,12 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros `user`::
 //resourcemacros     a free-form identifier
 //resourcemacros `state`::
-//resourcemacros     the initial state, one of `NOBUG_RESOURCE_WAITING`, `NOBUG_RESOURCE_TRYING`,
-//resourcemacros     `NOBUG_RESOURCE_EXCLUSIVE`, `NOBUG_RESOURCE_RECURSIVE` or `NOBUG_RESOURCE_SHARED`
+//resourcemacros     the state to enter
 //resourcemacros `handle`::
 //resourcemacros     a `NOBUG_RESOURCE_HANDLE` which will be initialized to the
 //resourcemacros     entering node
 //resourcemacros
-//resourcemacros 'RESOURCE_ENTER()' acts like the head of a C loop statement, it ties to the following
+//resourcemacros `RESOURCE_ENTER()` acts like the head of a C loop statement, it ties to the following
 //resourcemacros (block-) statement. Leaving and the user defined following statement are atomic.
 //resourcemacros This statement must not be left by break, return or any other kind of jump.
 //resourcemacros
@@ -1461,8 +1462,11 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros  RESOURCE_WAIT(flag, resource, user, handle)
 //resourcemacros  NOBUG_RESOURCE_WAIT_CTX(flag, resource, user, handle, context)
 //resourcemacros
-//resourcemacros This is just an alias for RESOURCE_ENTER(flag, resource, user, NOBUG_RESOURCE_WAITING, handle)
+//resourcemacros This is just an alias for
 //resourcemacros
+//resourcemacros  RESOURCE_ENTER(flag, resource, user,
+//resourcemacros                 NOBUG_RESOURCE_WAITING, handle)
+///resourcemacros
 //resourcemacros .How to use it
 //resourcemacros [source,c]
 //resourcemacros ----
@@ -1484,7 +1488,11 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros  RESOURCE_TRY(flag, resource, user, handle)
 //resourcemacros  NOBUG_RESOURCE_TRY_CTX(flag, resource, user, handle, context)
 //resourcemacros
-//resourcemacros This is just an alias for RESOURCE_ENTER(flag, resource, user, NOBUG_RESOURCE_TRYING, handle).
+//resourcemacros This is just an alias for
+//resourcemacros
+//resourcemacros  RESOURCE_ENTER(flag, resource, user,
+//resourcemacros                 NOBUG_RESOURCE_TRYING, handle)
+//resourcemacros
 //resourcemacros Trying on a resource is similar to waiting but will not trigger a deadlock check. This can be used
 //resourcemacros when a deadlock is expected at runtime and one handles this otherwise (by a timed wait or something like that).
 //resourcemacros
@@ -1512,7 +1520,7 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros `entered`::
 //resourcemacros     the handle set by `RESOURCE_ENTER`
 //resourcemacros
-//resourcemacros 'RESOURCE_STATE()' acts like the head of a C loop statement, it ties to the following
+//resourcemacros `RESOURCE_STATE()` acts like the head of a C loop statement, it ties to the following
 //resourcemacros (block-) statement. Leaving and the user defined following statement are atomic.
 //resourcemacros This statement must not be left by break, return or any other kind of jump.
 //resourcemacros
@@ -1573,7 +1581,7 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros `handle`::
 //resourcemacros     the handle you got while entering the resource
 //resourcemacros
-//resourcemacros 'RESOURCE_LEAVE()' acts like the head of a C loop statement, it ties to the following
+//resourcemacros `RESOURCE_LEAVE()` acts like the head of a C loop statement, it ties to the following
 //resourcemacros (block-) statement. Leaving and the user defined following statement are atomic.
 //resourcemacros This statement must not be left by break, return or any other kind of jump.
 //resourcemacros
@@ -1634,7 +1642,8 @@ NOTREACHED      abort           abort           nothing
 //resourcemacros  RESOURCE_ASSERT_STATE(resource, state)
 //resourcemacros  RESOURCE_ASSERT_STATE_IF(when, resource, state)
 //resourcemacros  NOBUG_RESOURCE_ASSERT_STATE_CTX(resource, state, context)
-//resourcemacros  NOBUG_RESOURCE_ASSERT_STATE_IF_CTX(when, resource, state, context)
+//resourcemacros  NOBUG_RESOURCE_ASSERT_STATE_IF_CTX(when, resource,
+//resourcemacros                                     state, context)
 //resourcemacros
 //resourcemacros Assert that we have a resource in a given state. For multithreaded programms the topmost
 //resourcemacros state of the calling thread is checked, for non threadeded programs the most recent state on