From b868d648439bb85fb1796deabf92c434861293fc Mon Sep 17 00:00:00 2001
From: Christian Thaeter <ct@pipapo.org>
Date: Thu, 29 Jul 2010 19:09:01 +0200
Subject: [PATCH] document: inner_core error handling overview

---
 doc/devel/the_inner_core/the_inner_core.txt | 44 ++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/doc/devel/the_inner_core/the_inner_core.txt b/doc/devel/the_inner_core/the_inner_core.txt
index 5c464d9ff..69fe42992 100644
--- a/doc/devel/the_inner_core/the_inner_core.txt
+++ b/doc/devel/the_inner_core/the_inner_core.txt
@@ -88,10 +88,52 @@ Errors
  * Errors are identified by pointers to static strings.
  * Errors are sticky (you cant set a new error unless the pending one got
    cleared).
- * macros for declaring and defining errors
+
+.General definition and declarations of errors
+Errors get declared in headers with the `LUMIERA_ERROR_DECLARE(err)` macro.
+
+Then the implementaton file uses the macros `LUMIERA_ERROR_DEFINE(err, msg)`
+to instance the error. There is no central registry, Any component can
+introduce its own errorcodes but must ensure that the error identifier is
+unique.
+
+.Error handling in C
+There are two helper macro forms for setting up error coditions, one is
+`LUMIERA_ERROR_SET..(flag, err, extra)` and the other one is
+`LUMIERA_ERROR_GOTO..(flag, err, extra)`. Each for differnt logging levels.
+The `SET` form just logs an error and sets it, the `GOTO` form also jumps to
+an error handler. Both take a NoBug flag used for logging and a optional
+`extra` c-string.
+
+
+[source,C]
+--------------------------------------------------------------------------------
+const char*
+mayfail()
+{
+  const char* ret = foo();
+  if (!ret)
+    LUMIERA_ERROR_GOTO (flag, FOO_FAILED);
+
+  if (!bar(ret))
+    LUMIERA_ERROR_GOTO (flag, BAR_FAILED,
+                        lumiera_tmpbuf_snprintf (256, "foo was %s", ret));
+
+  return "everything ok";
+
+  /* cleanup in reverse setup order */
+ BAR_FAILED:
+  lumiera_free (ret);
+ FOO_FAILED:
+  return NULL;
+}
+--------------------------------------------------------------------------------
+
 
 .C++ exceptions
 
+
+
 Memory Pools
 ~~~~~~~~~~~~