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 0a6fd8432d4623452b70f3732dfa7fb8efa1622c..b2b6dcf5e8adb0fbe0e6246c9f0afb7c35628b93 100644 (file)
--- 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"