Start documenting a few kconfig variables and user-visible options.

Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
Acked-by: Uwe Hermann <uwe@hermann-uwe.de>
git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4780 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

diff --git a/src/Kconfig b/src/Kconfig
index 241386dc988972bc3433f9bb6961d9291ca9cc7f..a06b43b1573e041532e871b58f4cdfad405e4e8d 100644 (file)
--- a/src/Kconfig
+++ b/src/Kconfig
@@ -195,6 +195,10 @@ config HAVE_MOVNTI
 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 GFXUMA
 
 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,16 +287,29 @@ config GENERATE_ACPI_TABLES
        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