[coreboot] [v2] r4780 - trunk/coreboot-v2/src

[svn at coreboot.org]

Author: uwe
Date: 2009-10-15 19:49:07 +0200 (Thu, 15 Oct 2009)
New Revision: 4780

Modified:
   trunk/coreboot-v2/src/Kconfig
Log:
Start documenting a few kconfig variables and user-visible options.

Signed-off-by: Uwe Hermann <uwe at hermann-uwe.de>
Acked-by: Uwe Hermann <uwe at hermann-uwe.de>



Modified: trunk/coreboot-v2/src/Kconfig
===================================================================
--- trunk/coreboot-v2/src/Kconfig	2009-10-15 14:23:33 UTC (rev 4779)
+++ trunk/coreboot-v2/src/Kconfig	2009-10-15 17:49:07 UTC (rev 4780)
@@ -195,6 +195,10 @@
 config HAVE_OPTION_TABLE
 	bool
 	default y
+	help
+	  This variable specifies whether a given board has a cmos.layout
+	  file containing NVRAM/CMOS bit definitions.
+	  It defaults to 'y' but can be changed to 'n' in mainboard/*/Kconfig.
 
 config PIRQ_ROUTE
 	bool
@@ -239,12 +243,27 @@
 
 config HAVE_ACPI_TABLES
 	bool
+	help
+	  This variable specifies whether a given board has ACPI table support.
+	  It is usually set in mainboard/*/Kconfig.
+	  Whether or not the ACPI tables are actually generated by coreboot
+	  is configurable by the user via GENERATE_ACPI_TABLES.
 
 config HAVE_MP_TABLE
 	bool
+	help
+	  This variable specifies whether a given board has MP table support.
+	  It is usually set in mainboard/*/Kconfig.
+	  Whether or not the MP table is actually generated by coreboot
+	  is configurable by the user via GENERATE_MP_TABLE.
 
 config HAVE_PIRQ_TABLE
 	bool
+	help
+	  This variable specifies whether a given board has PIRQ table support.
+	  It is usually set in mainboard/*/Kconfig.
+	  Whether or not the PIRQ table is actually generated by coreboot
+	  is configurable by the user via GENERATE_PIRQ_TABLE.
 
 config HAVE_HIGH_TABLES
 	bool
@@ -268,17 +287,30 @@
 	depends on HAVE_ACPI_TABLES
 	bool "Generate ACPI tables"
 	default y
+	help
+	  Generate ACPI tables for this board.
 
+	  If unsure, say Y.
+
 config GENERATE_MP_TABLE
 	depends on HAVE_MP_TABLE
 	bool "Generate an MP table"
 	default y
+	help
+	  Generate an MP table (conforming to the Intel MultiProcessor
+	  specification 1.4) for this board.
 
+	  If unsure, say Y.
+
 config GENERATE_PIRQ_TABLE
 	depends on HAVE_PIRQ_TABLE
 	bool "Generate a PIRQ table"
 	default y
+	help
+	  Generate a PIRQ table for this board.
 
+	  If unsure, say Y.
+
 endmenu
 
 menu "Payload"