[U-Boot] [PATCH] Document the format of the console environment variable

[Karsten Merker]

config_distro_bootcmd.h defines a common boot environment for
multiple platforms.  Document the format of the console
environment variable to allow the use of generic boot scripts
on all supported platforms.

Signed-off-by: Karsten Merker <merker at debian.org>
---
 doc/README.distro |    9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/README.distro b/doc/README.distro
index 0308a4c..3f7ee85 100644
--- a/doc/README.distro
+++ b/doc/README.distro
@@ -201,6 +201,15 @@ variables be set. Default values for these variables are often hard-coded into
 CONFIG_EXTRA_ENV_SETTINGS in the board's U-Boot configuration file, so that
 the user doesn't have to configure them.
 
+console:
+
+  Mandatory. The default console device to be passed to the Linux kernel.
+
+  The console device is specified in accordance with the guidelines
+  described in Documentation/serial-console.txt in the Linux kernel sources.
+  If the device is a serial port, the console variable must specify the
+  console baudrate in addition to the console device, e.g. "ttyS0,115200".
+
 fdt_addr:
 
   Mandatory for any system that provides the DTB in HW (e.g. ROM) and wishes
-- 
1.7.10.4