From afb4fb54707da2be227508d6bec9e52db9f4c726 Mon Sep 17 00:00:00 2001
From: Marcello Stanisci <stanisci.m@gmail.com>
Date: Fri, 25 May 2018 14:15:58 +0200
Subject: Commenting the "check keys" CMD.

---
 .../test_exchange_api_keys_cherry_picking_new.c    | 11 +++-----
 src/exchange-lib/testing_api_cmd_check_keys.c      | 30 +++++++++++++++-------
 2 files changed, 24 insertions(+), 17 deletions(-)

(limited to 'src/exchange-lib')

diff --git a/src/exchange-lib/test_exchange_api_keys_cherry_picking_new.c b/src/exchange-lib/test_exchange_api_keys_cherry_picking_new.c
index aa711436a..9c5fe9a36 100644
--- a/src/exchange-lib/test_exchange_api_keys_cherry_picking_new.c
+++ b/src/exchange-lib/test_exchange_api_keys_cherry_picking_new.c
@@ -64,7 +64,7 @@ run (void *cls,
 {
   struct TALER_TESTING_Command commands[] = {
 
-    /* Send signal to the exchange to see if it reacts */
+    /* Trigger keys reloading from disk.  */
     TALER_TESTING_cmd_signal ("signal-reaction-1",
                               is->exchanged,
                               SIGUSR1),
@@ -73,7 +73,8 @@ run (void *cls,
                                   1, 4,
                                   is->exchange),
 
-    TALER_TESTING_cmd_exec_keyup ("keyup-2", /* 1st keyup happens at start-up */
+    /* 1st keyup happens at start-up */
+    TALER_TESTING_cmd_exec_keyup ("keyup-2", 
                                   CONFIG_FILE_EXTENDED),
 
     TALER_TESTING_cmd_exec_auditor_sign ("sign-keys-1",
@@ -91,12 +92,6 @@ run (void *cls,
                                   8,
 #endif
                                   is->exchange),
-
-
-    /**
-     * End the suite.  Fixme: better to have a label for this
-     * too, as it shows "(null)" in logs.
-     */
     TALER_TESTING_cmd_end ()
   };
 
diff --git a/src/exchange-lib/testing_api_cmd_check_keys.c b/src/exchange-lib/testing_api_cmd_check_keys.c
index b14740e40..56b062a10 100644
--- a/src/exchange-lib/testing_api_cmd_check_keys.c
+++ b/src/exchange-lib/testing_api_cmd_check_keys.c
@@ -29,15 +29,21 @@
 #include "exchange_api_handle.h"
 #include "taler_testing_lib.h"
 
+
+/**
+ * State for a "check keys" CMD.
+ */
 struct CheckKeysState
 {
   /**
-   * FIXME
+   * How many times the /keys response was received by the
+   * exchange under test.
    */
   unsigned int generation;
 
   /**
-   * FIXME
+   * How many denomination keys the exchange is supposed to
+   * have.
    */
   unsigned int num_denom_keys;
 
@@ -50,10 +56,10 @@ struct CheckKeysState
 
 
 /**
- * Run the command.
+ * Run the "check keys" command.
  *
- * @param cls closure, typically a #struct SignalState.
- * @param cmd the command to execute, a /wire one.
+ * @param cls closure.
+ * @param cmd the command currently being executed.
  * @param is the interpreter state.
  */
 static void
@@ -107,7 +113,7 @@ check_keys_run (void *cls,
 /**
  * Cleanup the state.
  *
- * @param cls closure, typically a #struct SignalState.
+ * @param cls closure.
  * @param cmd the command which is being cleaned up.
  */
 static void
@@ -121,11 +127,15 @@ check_keys_cleanup (void *cls,
 
 
 /**
- * Make a "check keys" command.
+ * Make a "check keys" command.  This type of command
+ * checks whether the number of denomination keys from
+ * @a exchange matches @a num_denom_keys.
  *
  * @param label command label
- * @param generation FIXME
- * @param num_denom_keys FIXME
+ * @param generation how many /keys responses are expected to
+ *        have been returned when this CMD will be run.
+ * @param num_denom_keys expected number of denomination keys.
+ * @param exchange connection handle to the exchange to test.
  *
  * @return the command.
  */
@@ -149,3 +159,5 @@ TALER_TESTING_cmd_check_keys
   cmd.cleanup = &check_keys_cleanup;
   return cmd;
 }
+
+/* end of testing_api_cmd_check_keys.c */
-- 
cgit v1.2.3