pxe: Modify README to add the description about FIT image
authorWenbin Song <wenbin.song@nxp.com>
Thu, 1 Sep 2016 08:28:22 +0000 (16:28 +0800)
committerTom Rini <trini@konsulko.com>
Wed, 7 Sep 2016 12:49:03 +0000 (08:49 -0400)
Use environment variable "kernel_addr_r" to indicate the location
in RAM where FIT image will be stored.
Use label command "kernel" to indicate which <path> the FIT image at.

Signed-off-by: Wenbin Song <wenbin.song@nxp.com>
doc/README.pxe

index cc182c9..db11658 100644 (file)
@@ -78,9 +78,9 @@ pxe boot
      address of the tftp server from which other files will be retrieved.
 
      kernel_addr_r, initrd_addr_r - locations in RAM at which 'pxe boot' will
-     store the kernel and initrd it retrieves from tftp. These locations will
-     be passed to the bootm command to boot the kernel. These environment
-     variables are required to be set.
+     store the kernel(or FIT image) and initrd it retrieves from tftp. These
+     locations will be passed to the bootm command to boot the kernel. These
+     environment variables are required to be set.
 
      fdt_addr_r - location in RAM at which 'pxe boot' will store the fdt blob it
      retrieves from tftp. The retrieval is possible if 'fdt' label is defined in
@@ -138,9 +138,9 @@ menu default            - set this label as the default label to boot; this is
                      specified in a different way
 
 kernel <path>      - if this label is chosen, use tftp to retrieve the kernel
-                     at <path>. it will be stored at the address indicated in
-                     the kernel_addr_r environment variable, and that address
-                     will be passed to bootm to boot this kernel.
+                     (or FIT image) at <path>. it will be stored at the address
+                     indicated in the kernel_addr_r environment variable, and
+                     that address will be passed to bootm to boot this kernel.
 
 append <string>            - use <string> as the kernel command line when booting this
                      label.