Clean-up: change some long standing TODOs into tickets

makes the test logs way more readable

Believe me: no one will ever notice a "TODO"
entry in the logs, when it showed up for
more than some months.

Thus I've created some new tickets, mostly
tagged as "QA" and placed the ticket number
at the corresponding locations in the source

src/backend/backend.c

@@ -102,7 +102,8 @@ lumiera_backend_init (void)
 
   lumiera_backend_pagesize = sysconf(_SC_PAGESIZE);
 
-  TODO ("add config options to override following defaults");
+  /////////////////////////////////////////////////////////////////////TICKET #838 add config options to override following defaults"
+
 
   const char* filehandles = lumiera_tmpbuf_snprintf (SIZE_MAX,
                                                      "backend.file.max_handles = %d",
@@ -168,7 +169,7 @@ lumiera_backend_mpool_purge (enum lumiera_resource_try itr, void* data, void* co
   (void) context;
   (void) data;
   (void) itr;
-  TODO("mpool_purge ((MPool) data)");
+  ///////////////////////////////////////////////////////////TICKET #837 actually implement mpool purging
   return LUMIERA_RESOURCE_NONE;
 }
 

src/backend/threadpool.c

@@ -76,8 +76,9 @@ lumiera_threadpool_destroy(void)
     {
       LUMIERA_CONDITION_SECTION (cond_sync, &threadpool.pool[i].sync)
         {
-          TODO ("check threads deadlines, kill them when they are stalled");
-          TODO ("for threads without deadline use a timeout from config system, 500ms or so by default");
+          //////////////////////////////////////////TICKET #843 check threads deadlines, kill them when they are stalled"
+          //////////////////////////////////////////TICKET #843 for threads without deadline use a timeout from config system, 500ms or so by default
+
           LUMIERA_CONDITION_WAIT(llist_is_empty (&threadpool.pool[i].working_list));
         }
     }
@@ -136,7 +137,9 @@ lumiera_threadpool_acquire_thread (enum lumiera_thread_class kind,
               llist_insert_head (&threadpool.pool[kind].working_list, &ret->node);
 
               ENSURE (ret, "did not create a valid thread");
-              TODO ("no error handing, let the resourcecollector do it, no need when returning the thread");
+                //////////////////////////////////////////////////////////////////////TICKET #844 no error must be pending here
+                //////////////////////////////////////////////////////////////////////TICKET #844 let the resourcecollector do it, no need when returning the thread
+                
               LUMIERA_CONDITION_WAIT (!llist_is_empty (&threadpool.pool[kind].idle_list));
             }
           // use an existing thread, pick the first one

src/backend/threads.c

@@ -120,7 +120,7 @@ thread_loop (void* thread)
 
       INFO (threads, "Thread Shutdown");
     }
-  TODO ("no error must be pending here, else do app shutdown");
+  //////////////////////////////////////////////////////////////////////TICKET #844 no error must be pending here, else do app shutdown
   return 0;
 }
 
@@ -322,7 +322,7 @@ lumiera_thread_sync (void)
   self->state = LUMIERA_THREADSTATE_SYNCING;
   lumiera_condition_signal (&self->signal, &NOBUG_FLAG(threads), NOBUG_CONTEXT);
 
-  TODO("error handing, maybe timed mutex (using the threads heartbeat timeout, shortly before timeout)");
+  //////////////////////////////////////////TICKET #843 error handing, maybe timed mutex (using the threads heartbeat timeout, shortly before timeout)
 
   while (self->state == LUMIERA_THREADSTATE_SYNCING) {
     lumiera_condition_wait (&self->signal, &NOBUG_FLAG(threads), self->rh, NOBUG_CONTEXT);

src/common/config-lookup.c

@@ -23,7 +23,7 @@
 #include "lib/safeclib.h"
 #include "lib/tmpbuf.h"
 
-#include "common/config_lookup.h"
+#include "common/config-lookup.h"
 #include "common/config.h"
 
 /* we only use one fatal error for now, when allocation in the config system fail, something else is pretty wrong */
@@ -76,7 +76,8 @@ lumiera_config_lookup_insert (LumieraConfigLookup self, LumieraConfigitem item)
   REQUIRE (item->key);
   REQUIRE (item->key_size);
 
-  FIXME ("implement section prefix/suffix for the key");
+  ////////////////////////////////////////TICKET #839 implement section prefix/suffix for the key"
+  
   const char* key = lumiera_tmpbuf_strcat3 (NULL, 0, item->key, item->key_size, NULL, 0);
 
   LumieraConfigLookupentry entry = (LumieraConfigLookupentry)psplay_find (&self->tree, key, 100);
@@ -101,7 +102,9 @@ lumiera_config_lookup_insert_default (LumieraConfigLookup self, LumieraConfigite
   LumieraConfigLookupentry entry = (LumieraConfigLookupentry)psplay_find (&self->tree, key, 100);
   if (!entry)
     entry = (LumieraConfigLookupentry)psplay_insert (&self->tree, &lumiera_config_lookupentry_new (key)->node, 100);
-  TODO ("else check that no 'default' item already exists, that is, the tail element's parent points to the 'defaults' in config");
+  
+   ////////////////////////////////////////TICKET #839 check that no 'default' item already exists when inserting a default
+   ////////////////////////////////////////TICKET #839 ...that is, the tail element's parent points to the 'defaults' in config
 
   llist_insert_tail (&entry->configitems, &item->lookup);
   return entry;

src/common/config-lookup.h

@@ -1,5 +1,5 @@
 /*
-  config_lookup.h  -  Lookup functions for the config subsystem
+  CONFIG-LOOKUP.h  -  Lookup functions for the config subsystem
 
   Copyright (C)         Lumiera.org
     2008,               Christian Thaeter <ct@pipapo.org>

src/common/config.h

@@ -51,7 +51,7 @@ LUMIERA_ERROR_DECLARE (CONFIG_NO_ENTRY);
 
 
 //TODO: Lumiera header includes//
-#include "common/config_lookup.h"
+#include "common/config-lookup.h"
 #include "common/configitem.h"
 
 //TODO: System includes//

src/common/configentry.c

@@ -43,7 +43,7 @@ lumiera_configentry_new (LumieraConfigitem tmp)
   LumieraConfigentry self = lumiera_malloc (sizeof (*self));
   lumiera_configitem_move ((LumieraConfigitem)self, tmp);
 
-  TODO ("initialize other stuff here (lookup, parent, ...)");
+  //////////////////////////////////////////////////////////////////TICKET #839 initialise other stuff here (lookup, parent, ...)
 
   return (LumieraConfigitem)self;
 }
@@ -52,7 +52,7 @@ lumiera_configentry_new (LumieraConfigitem tmp)
 LumieraConfigitem
 lumiera_configentry_destroy (LumieraConfigitem self)
 {
-  TODO ("cleanup other stuff here (lookup, parent, ...)");
+  //////////////////////////////////////////////////////////////////TICKET #839 cleanup other stuff here (lookup, parent, ...)
 
   return self;
 }

src/common/configitem.c

@@ -20,6 +20,13 @@
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
+
+/** @file configitem.c
+ ** create a configitem out of a single line.
+ **
+ */
+
+
 #include "include/logging.h"
 #include "lib/llist.h"
 #include "lib/safeclib.h"
@@ -43,12 +50,6 @@ static LumieraConfigitem parse_configentry (LumieraConfigitem self, char* itr);
 #include <stdint.h>
 
 
-/**
- * @file
- * create a configitem out of a single line.
- *
- */
-
 
 LumieraConfigitem
 lumiera_configitem_init (LumieraConfigitem self)
@@ -176,11 +177,11 @@ lumiera_configitem_parse (LumieraConfigitem self, const char* line)
   lumiera_free (self->line);
   self->line = lumiera_strndup (line, SIZE_MAX);
 
-  FIXME ("MOCKUP START");
+  /////////////////////////TODO do a real startup here
 
   char* itr = self->line;
 
-  /* skip leading whitespaces */
+  /* skip leading whitespace */
   while (*itr && isspace (*itr))
     itr++;
 
@@ -215,7 +216,7 @@ parse_directive (LumieraConfigitem self, char* itr)
   /* itr points now to @ */
   self->key = itr;
 
-  /* check whether there are illegal whitespaces after @ */
+  /* check whether there are illegal whitespace after @ */
   itr++;
   if (*itr && !isspace(*itr))
     {
@@ -224,7 +225,7 @@ parse_directive (LumieraConfigitem self, char* itr)
 
       itr += self->key_size;
 
-      /* we need a key with a length greather than zero and */
+      /* we need a key with a length greater than zero and */
       /* either end of line or whitespace after key */
 
       if ( self->key_size && ( !*itr || (*itr && isspace(*itr)) ))

src/common/configitem.h

@@ -33,7 +33,7 @@ typedef lumiera_configitem* LumieraConfigitem;
 struct lumiera_configitem_vtable;
 
 //TODO: Lumiera header includes//
-#include "common/config_lookup.h"
+#include "common/config-lookup.h"
 
 
 //TODO: System includes//

src/lib/hash-fnv.c

@@ -39,7 +39,7 @@ slightly modified and adapted to C99; no copyright applies:
 */
 
 
-#include "hash_fnv.h"
+#include "lib/hash-fnv.h"
 
 #include <nobug.h>
 

src/lib/hash-fnv.h

@@ -1,5 +1,5 @@
 /*
- hash_fnv.c     - FNV hash functions
+ HASH-FNV.h     - FNV hash functions
 
  Copyright (C)
    2010, 2011,                  Christian Thaeter <ct@pipapo.org>

src/lib/test/suite.cpp

@@ -165,6 +165,7 @@ namespace test {
     {
       try 
         {
+          INFO (test, "++------------------- invoking TEST: %s", showType(theTest).c());
           theTest.run (cmdline);
           return Suite::TEST_OK;
         }

src/proc/asset/media.cpp

@@ -149,7 +149,7 @@ namespace asset {
     asset::Media* pM (0);
     AssetManager& aMang = AssetManager::instance();
     
-    TODO ("check and fix Category if necessary");
+    //////////////////////////////////////////////////////////TICKET #841 check and fix Category if necessary
     
     if (isnil (file))
       {
@@ -168,7 +168,7 @@ namespace asset {
         MediaDesc& handle = maf.queryFile(key.name);
         Duration length = handle.length;
         
-        TODO ("detecting and wiring multichannel compound media!");
+        //////////////////////////////////////////////////////////TICKET #841 detecting and wiring multichannel compound media
         pM = new Media (key,file,length); 
       }
     ASSERT (pM);

src/proc/assetmanager.cpp

@@ -111,11 +111,11 @@ namespace asset {
   {
     AssetManager& _aMang (AssetManager::instance());
     DB& registry (_aMang.registry);
-    TODO ("check validity of Ident Category");
+    //////////////////////////////////////////////////////////TICKET #840 check validity of Ident Category
     ID<KIND> asset_id (getID (idi));
     
     DB::Lock guard(&registry);
-    TODO ("handle duplicate Registrations");
+    //////////////////////////////////////////////////////////TICKET #840 handle duplicate Registrations
     P<KIND> smart_ptr (obj, &destroy);
     
     registry.put (asset_id, smart_ptr);

src/proc/mobject/session/sess-manager-impl.cpp

@@ -210,7 +210,7 @@ namespace session {
   
   SessManagerImpl::~SessManagerImpl ()
   {
-    TODO ("verify sane lifecycle");
+                               //////////////////////////////////////// TICKET #845 verify sane session manager lifecycle here
     Session::initFlag = false;
   }