[coreboot] r831 - coreboot-v3/include

[svn at coreboot.org]

Author: hailfinger
Date: 2008-08-28 01:15:28 +0200 (Thu, 28 Aug 2008)
New Revision: 831

Modified:
   coreboot-v3/include/globalvars.h
Log:
Improve global variable documentation.

Signed-off-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006 at gmx.net>
Acked-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006 at gmx.net>


Modified: coreboot-v3/include/globalvars.h
===================================================================
--- coreboot-v3/include/globalvars.h	2008-08-27 22:58:04 UTC (rev 830)
+++ coreboot-v3/include/globalvars.h	2008-08-27 23:15:28 UTC (rev 831)
@@ -36,6 +36,10 @@
  * is NO buffer at the end of the struct, so having zero-sized arrays at the
  * end or similar stuff for which the compiler can't determine the final size
  * will corrupt memory. If you don't try to be clever, everything will be fine.
+ *
+ * BIG FAT WARNING: Never write to global variables without using accessor
+ * functions. global_vars_init() is the place to call variable-specific
+ * initialization functions.
  */
 struct global_vars {
 #ifdef CONFIG_CONSOLE_BUFFER