Browse Source

base-files: upgrade: nand: document nand_do_upgrade()

Describe what firmware files are supported.

Signed-off-by: Rafał Miłecki <[email protected]>
Rafał Miłecki 1 year ago
parent
commit
4565699ebe
1 changed files with 10 additions and 0 deletions
  1. 10 0
      package/base-files/files/lib/upgrade/nand.sh

+ 10 - 0
package/base-files/files/lib/upgrade/nand.sh

@@ -419,6 +419,16 @@ nand_do_restore_config() {
 }
 
 # Recognize type of passed file and start the upgrade process
+#
+# Supported firmware containers:
+# 1. Raw file
+# 2. Gzip
+#
+# Supported data formats:
+# 1. Tar with kernel/rootfs
+# 2. UBI image (built using "ubinized")
+# 3. UBIFS image (to update UBI volume with)
+# 4. FIT image (to update UBI volume with)
 nand_do_upgrade() {
 	local file="$1"