Merge branch 'net' of git://git.denx.de/u-boot-socfpga

[oweals/u-boot.git] / doc / README.pxe

diff --git a/doc/README.pxe b/doc/README.pxe
index cc182c972d7ae8d40f966781a3238ec8a55c1ac9..42f913c61feba1b61ccbf46e1c51fe0a34d64fe3 100644 (file)
--- a/doc/README.pxe
+++ b/doc/README.pxe
@@ -1,7 +1,6 @@
+SPDX-License-Identifier: GPL-2.0+
 /*
  * Copyright 2010-2011 Calxeda, Inc.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 The 'pxe' commands provide a near subset of the functionality provided by
@@ -78,9 +77,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 +137,16 @@ 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.
+                     For FIT image, The configuration specification can be
+                     appended to the file name, with the format:
+                       <path>#<conf>[#<extra-conf[#...]]
+                     It will passed to bootm with that address.
+                     (see: doc/uImage.FIT/command_syntax_extensions.txt)
+                     It useful for overlay selection in pxe file
+                     (see: doc/uImage.FIT/overlay-fdt-boot.txt)
 
 append <string>            - use <string> as the kernel command line when booting this
                      label.