From: Carsten Haitzler (Rasterman) <raster@rasterman.com>
Date: Mon, 5 Oct 2015 07:04:31 +0000 (+0900)
Subject: ecore docs - adjust docs to be explicit about ecore main loops nesting
X-Git-Tag: v1.16.0-alpha1~5
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=594dab807854483dbd55e0e4a7d78d5fc55b4f3f;p=platform%2Fupstream%2Fefl.git

ecore docs - adjust docs to be explicit about ecore main loops nesting

it seems some people think ecore main loops can nest. they can't. be
explicit in docs.
---

diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h
index cc514bb..0723fdc 100644
--- a/src/lib/ecore/Ecore_Common.h
+++ b/src/lib/ecore/Ecore_Common.h
@@ -248,6 +248,10 @@ EAPI void ecore_main_loop_glib_always_integrate_disable(void);
  * handlers, etc. Once everything is done, before entering again on idle state,
  * any callback set as @c Idle_Enterer will be called.
  *
+ * This function should be called once only from the same thread that
+ * initted ecore, eina etc. (ecore_init(), eina_init(), ...) and should never
+ * be nested. Never call it from within an instance of itself.
+ *
  * Each main loop iteration is done by calling ecore_main_loop_iterate()
  * internally.
  *