From: Rafał Miłecki <rafal@milecki.pl>
Date: Fri, 12 Jul 2024 09:36:46 +0000 (+0200)
Subject: base-files: upgrade: nand: document nand_do_upgrade()
X-Git-Url: http://git.lede-project.org./?a=commitdiff_plain;h=4565699ebeff39f0e4ace9da42df219a0faf181c;p=openwrt%2Fstaging%2Fthess.git

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

Describe what firmware files are supported.

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---

diff --git a/package/base-files/files/lib/upgrade/nand.sh b/package/base-files/files/lib/upgrade/nand.sh
index 0a6fd8432d..b2b6dcf5e8 100644
--- a/package/base-files/files/lib/upgrade/nand.sh
+++ b/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"