[GNUnet-SVN] r28927 - in gnunet/src: include util

[gnunet]

Author: grothoff
Date: 2013-08-30 20:11:02 +0200 (Fri, 30 Aug 2013)
New Revision: 28927

Modified:
   gnunet/src/include/gnunet_mesh_service.h
   gnunet/src/include/gnunet_scheduler_lib.h
   gnunet/src/util/crypto_ecc.c
   gnunet/src/util/scheduler.c
Log:
-docu

Modified: gnunet/src/include/gnunet_mesh_service.h
===================================================================
--- gnunet/src/include/gnunet_mesh_service.h    2013-08-30 18:10:52 UTC (rev 
28926)
+++ gnunet/src/include/gnunet_mesh_service.h    2013-08-30 18:11:02 UTC (rev 
28927)
@@ -96,11 +96,11 @@
  * Functions with this signature are called whenever a message is
  * received.
  * 
- * Each time the function must call GNUNET_MESH_receive_done on the tunnel
+ * Each time the function must call #GNUNET_MESH_receive_done on the tunnel
  * in order to receive the next message. This doesn't need to be immediate:
  * can be delayed if some processing is done on the message.
  *
- * @param cls Closure (set from GNUNET_MESH_connect).
+ * @param cls Closure (set from #GNUNET_MESH_connect).
  * @param tunnel Connection to the other end.
  * @param tunnel_ctx Place to store local state associated with the tunnel.
  * @param message The actual message.
@@ -193,7 +193,7 @@
  *                It is NOT called if GNUNET_MESH_tunnel_destroy is called on
  *                the tunnel.
  * @param handlers Callbacks for messages we care about, NULL-terminated. Each
- *                 one must call GNUNET_MESH_receive_done on the tunnel to
+ *                 one must call #GNUNET_MESH_receive_done on the tunnel to
  *                 receive the next message.  Messages of a type that is not
  *                 in the handlers array are ignored if received. 
  * @param ports NULL or 0-terminated array of port numbers for incoming 
tunnels.

Modified: gnunet/src/include/gnunet_scheduler_lib.h
===================================================================
--- gnunet/src/include/gnunet_scheduler_lib.h   2013-08-30 18:10:52 UTC (rev 
28926)
+++ gnunet/src/include/gnunet_scheduler_lib.h   2013-08-30 18:11:02 UTC (rev 
28927)
@@ -327,9 +327,15 @@
 
 
 /**
- * Schedule a new task to be run as soon as possible. The task
- * will be run with the DEFAULT priority.
+ * Schedule a new task to be run as soon as possible. Note that this
+ * does not guarantee that this will be the next task that is being
+ * run, as other tasks with higher priority (or that are already ready
+ * to run) might get to run first.  Just as with delays, clients must
+ * not rely on any particular order of execution between tasks
+ * scheduled concurrently.
  *
+ * The task will be run with the DEFAULT priority.
+ *
  * @param task main function of the task
  * @param task_cls closure of @a task
  * @return unique task identifier for the job

Modified: gnunet/src/util/crypto_ecc.c
===================================================================
--- gnunet/src/util/crypto_ecc.c        2013-08-30 18:10:52 UTC (rev 28926)
+++ gnunet/src/util/crypto_ecc.c        2013-08-30 18:11:02 UTC (rev 28927)
@@ -49,7 +49,7 @@
  * a failure of the command 'cmd' with the message given
  * by gcry_strerror(rc).
  */
-#define LOG_GCRY(level, cmd, rc) do { LOG(level, _("`%s' failed at %s:%d with 
error: %s\n"), cmd, __FILE__, __LINE__, gcry_strerror(rc)); } while(0);
+#define LOG_GCRY(level, cmd, rc) do { LOG(level, _("`%s' failed at %s:%d with 
error: %s\n"), cmd, __FILE__, __LINE__, gcry_strerror(rc)); } while(0)
 
 
 /**

Modified: gnunet/src/util/scheduler.c
===================================================================
--- gnunet/src/util/scheduler.c 2013-08-30 18:10:52 UTC (rev 28926)
+++ gnunet/src/util/scheduler.c 2013-08-30 18:11:02 UTC (rev 28927)
@@ -1152,11 +1152,17 @@
 
 
 /**
- * Schedule a new task to be run as soon as possible. The task
- * will be run with the DEFAULT priority.
+ * Schedule a new task to be run as soon as possible.  Note that this
+ * does not guarantee that this will be the next task that is being
+ * run, as other tasks with higher priority (or that are already ready
+ * to run) might get to run first.  Just as with delays, clients must
+ * not rely on any particular order of execution between tasks
+ * scheduled concurrently.
+ * 
+ * The task will be run with the DEFAULT priority.
  *
  * @param task main function of the task
- * @param task_cls closure of task
+ * @param task_cls closure of @a task
  * @return unique task identifier for the job
  *         only valid until "task" is started!
  */