Merge branch 'master' into l20integration

1 files changed, 28 insertions, 21 deletions

diff --git a/src/include/gnunet_testing_ng_lib.h b/src/include/gnunet_testing_ng_lib.h
index eff45498b..07cdac962 100644
--- a/src/include/gnunet_testing_ng_lib.h
+++ b/src/include/gnunet_testing_ng_lib.h
@@ -76,7 +76,7 @@ struct GNUNET_TESTING_AsyncContext
   /**
    * Interpreter we are part of.
    */
-  struct GNUNET_TESTING_Interpreter *is;
+  struct GNUNET_TESTING_Interpreter *is; // Why needed? When available?
 
   /**
    * Function to call when done.
@@ -96,18 +96,21 @@ struct GNUNET_TESTING_AsyncContext
   enum GNUNET_GenericReturnValue finished;
 };
 
+
 typedef void
 (*GNUNET_TESTING_CommandRunRoutine)(void *cls,
                                     struct GNUNET_TESTING_Interpreter *is);
 
+
 typedef void
 (*GNUNET_TESTING_CommandCleanupRoutine)(void *cls);
 
-typedef  enum GNUNET_GenericReturnValue
-(*GNUNET_TESTING_CommandGetTraits)(void *cls,
-                                   const void **ret,
-                                   const char *trait,
-                                   unsigned int index);
+
+typedef enum GNUNET_GenericReturnValue
+(*GNUNET_TESTING_CommandGetTraits) (void *cls,
+                                    const void **ret,
+                                    const char *trait,
+                                    unsigned int index);
 
 /**
  * Create a new command
@@ -246,6 +249,7 @@ struct GNUNET_TESTING_Command
  * @param label label of the command to lookup.
  * @return the command, if it is found, or NULL.
  */
+// FIXME: think harder about whether this is actually needed, likely not.
 const struct GNUNET_TESTING_Command *
 GNUNET_TESTING_interpreter_lookup_future_command (
   struct GNUNET_TESTING_Interpreter *is,
@@ -327,10 +331,13 @@ GNUNET_TESTING_cmd_end (void);
 
 
 /**
- * Turn asynchronous command into non blocking command by setting asynchronous_finish to true.
- * FIXME: what is this API doing? Is it returning a new cmd which is unblocking?
- * Is it modifying cmd?
- * Looking at the code, it both modifying cmd AND returning a copy oO
+ * Turn asynchronous command into non blocking command by setting
+ * asynchronous_finish to true.  Modifies (and then returns) @a cmd simply
+ * setting the bit. By default, most commands are blocking, and by wrapping
+ * the command construction in this function a blocking command can be turned
+ * into an asynchronous command where the interpreter continues after
+ * initiating the asynchronous action. Does nothing if the command is
+ * fundamentally synchronous.
  *
  * @param cmd command to make synchronous.
  * @return a finish-command.
@@ -894,11 +901,11 @@ struct GNUNET_TESTING_StartPeerState
  */
 #define GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT(name,type)   \
   enum GNUNET_GenericReturnValue                          \
-    GNUNET_TESTING_get_trait_ ## name (                    \
+  GNUNET_TESTING_get_trait_ ## name (                    \
     const struct GNUNET_TESTING_Command *cmd,              \
     type **ret);                                          \
   struct GNUNET_TESTING_Trait                              \
-    GNUNET_TESTING_make_trait_ ## name (                   \
+  GNUNET_TESTING_make_trait_ ## name (                   \
     type * value);
 
 
@@ -908,9 +915,9 @@ struct GNUNET_TESTING_StartPeerState
  */
 #define GNUNET_TESTING_MAKE_IMPL_SIMPLE_TRAIT(name,type)  \
   enum GNUNET_GenericReturnValue                         \
-    GNUNET_TESTING_get_trait_ ## name (                   \
+  GNUNET_TESTING_get_trait_ ## name (                   \
     const struct GNUNET_TESTING_Command *cmd,             \
-    type **ret)                                          \
+    type * *ret)                                          \
   {                                                      \
     if (NULL == cmd->traits) return GNUNET_SYSERR;       \
     return cmd->traits (cmd->cls,                        \
@@ -919,7 +926,7 @@ struct GNUNET_TESTING_StartPeerState
                         0);                              \
   }                                                      \
   struct GNUNET_TESTING_Trait                             \
-    GNUNET_TESTING_make_trait_ ## name (                  \
+  GNUNET_TESTING_make_trait_ ## name (                  \
     type * value)                                        \
   {                                                      \
     struct GNUNET_TESTING_Trait ret = {                   \
@@ -936,14 +943,14 @@ struct GNUNET_TESTING_StartPeerState
  */
 #define GNUNET_TESTING_MAKE_DECL_INDEXED_TRAIT(name,type)  \
   enum GNUNET_GenericReturnValue                          \
-    GNUNET_TESTING_get_trait_ ## name (                    \
+  GNUNET_TESTING_get_trait_ ## name (                    \
     const struct GNUNET_TESTING_Command *cmd,              \
     unsigned int index,                                   \
     type **ret);                                          \
   struct GNUNET_TESTING_Trait                              \
-    GNUNET_TESTING_make_trait_ ## name (                   \
+  GNUNET_TESTING_make_trait_ ## name (                   \
     unsigned int index,                                   \
-    type * value);
+    type *value);
 
 
 /**
@@ -952,10 +959,10 @@ struct GNUNET_TESTING_StartPeerState
  */
 #define GNUNET_TESTING_MAKE_IMPL_INDEXED_TRAIT(name,type) \
   enum GNUNET_GenericReturnValue                         \
-    GNUNET_TESTING_get_trait_ ## name (                   \
+  GNUNET_TESTING_get_trait_ ## name (                   \
     const struct GNUNET_TESTING_Command *cmd,             \
     unsigned int index,                                  \
-    type **ret)                                          \
+    type * *ret)                                          \
   {                                                      \
     if (NULL == cmd->traits) return GNUNET_SYSERR;       \
     return cmd->traits (cmd->cls,                        \
@@ -964,7 +971,7 @@ struct GNUNET_TESTING_StartPeerState
                         index);                          \
   }                                                      \
   struct GNUNET_TESTING_Trait                             \
-    GNUNET_TESTING_make_trait_ ## name (                  \
+  GNUNET_TESTING_make_trait_ ## name (                  \
     unsigned int index,                                  \
     type * value)                                        \
   {                                                      \