From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Wed, 9 Sep 2009 14:02:35 +0000 (+0000)
Subject: doc: Update proc.h documentation.
X-Git-Tag: 2.2.0~57
X-Git-Url: https://codewiz.org/gitweb?p=bertos.git;a=commitdiff_plain;h=d394bdd12408a16d6c322d2c9804ecd27c5d2998

doc: Update proc.h documentation.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2911 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/bertos/kern/proc.h b/bertos/kern/proc.h
index efbdf458..b396a2c9 100644
--- a/bertos/kern/proc.h
+++ b/bertos/kern/proc.h
@@ -71,6 +71,14 @@ void proc_init(void);
 /**
  * Create a new named process and schedules it for execution.
  *
+ * When defining the stacksize take into account that you may want at least:
+ * \li save all the registers for each nested function call;
+ * \li have memory for the struct Process, which is positioned at the bottom
+ * of the stack;
+ * \li have some memory for temporary variables inside called functions.
+ *
+ * The value given by CONFIG_KERN_MINSTACKSIZE is rather safe to use in the first place.
+ *
  * \note The function
  * \code
  * proc_new(entry, data, stacksize, stack)