[console] Tidy up config/console.h

Signed-off-by: Michael Brown <mcb30@ipxe.org>

diff --git a/src/config/console.h b/src/config/console.h
index ffa5cf50d48a2a032f5975b574a23e26c7264644..d1d504527d90431add861762879515f2d4ce8315 100644 (file)
--- a/src/config/console.h
+++ b/src/config/console.h
@@ -5,7 +5,7 @@
  *
  * Console configuration
  *
- * These options specify the console types that Etherboot will use for
+ * These options specify the console types that iPXE will use for
  * interaction with the user.
  *
  */
@@ -14,19 +14,51 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 
 #include <config/defaults.h>
 
-//#define      CONSOLE_PCBIOS          /* Default BIOS console */
-//#define      CONSOLE_SERIAL          /* Serial port */
-//#define      CONSOLE_DIRECT_VGA      /* Direct access to VGA card */
-//#define      CONSOLE_PC_KBD          /* Direct access to PC keyboard */
+/*
+ * Default console types
+ *
+ * These are all enabled by default for the appropriate platforms.
+ * You may disable them if needed.
+ *
+ */
+
+//#undef       CONSOLE_PCBIOS          /* Default BIOS console */
+//#undef       CONSOLE_EFI             /* Default EFI console */
+//#undef       CONSOLE_LINUX           /* Default Linux console */
+
+/*
+ * Additional console types
+ *
+ * These are not enabled by default, but may be useful in your
+ * environment.
+ *
+ */
+
+//#define      CONSOLE_SERIAL          /* Serial port console */
+//#define      CONSOLE_VESAFB          /* VESA framebuffer console */
 //#define      CONSOLE_SYSLOG          /* Syslog console */
 //#define      CONSOLE_SYSLOGS         /* Encrypted syslog console */
 //#define      CONSOLE_VMWARE          /* VMware logfile console */
-//#define      CONSOLE_DEBUGCON        /* Debug port console */
-//#define      CONSOLE_VESAFB          /* VESA framebuffer console */
+//#define      CONSOLE_DEBUGCON        /* Bochs/QEMU/KVM debug port console */
 //#define      CONSOLE_INT13           /* INT13 disk log console */
 
+/*
+ * Very obscure console types
+ *
+ * You almost certainly do not need to enable these.
+ *
+ */
+
+//#define      CONSOLE_DIRECT_VGA      /* Direct access to VGA card */
+//#define      CONSOLE_PC_KBD          /* Direct access to PC keyboard */
+
+/* Keyboard map (available maps in hci/keymap/) */
 #define        KEYBOARD_MAP    us
 
+/* Control which syslog() messages are generated.
+ *
+ * Note that this is not related in any way to CONSOLE_SYSLOG.
+ */
 #define        LOG_LEVEL       LOG_NONE
 
 #include <config/named.h>