From e6dc58b16f9e0fc8effce4b93c9c6c05052ee37c Mon Sep 17 00:00:00 2001 From: Carl-Daniel Hailfinger Date: Wed, 27 Aug 2008 23:15:28 +0000 Subject: [PATCH] Improve global variable documentation. Signed-off-by: Carl-Daniel Hailfinger Acked-by: Carl-Daniel Hailfinger git-svn-id: svn://coreboot.org/repository/coreboot-v3@831 f3766cd6-281f-0410-b1cd-43a5c92072e9 --- include/globalvars.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/globalvars.h b/include/globalvars.h index 356be346c7..6f2cebacdc 100644 --- a/include/globalvars.h +++ b/include/globalvars.h @@ -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