diff mbox series

[1/3] base-files: upgrade: nand: document nand_do_upgrade()

Message ID 20240712093648.20748-1-zajec5@gmail.com
State Accepted
Delegated to: Rafał Miłecki
Headers show
Series [1/3] base-files: upgrade: nand: document nand_do_upgrade() | expand

Commit Message

Rafał Miłecki July 12, 2024, 9:36 a.m. UTC 
From: Rafał Miłecki <rafal@milecki.pl>

Describe what firmware files are supported.

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---
 package/base-files/files/lib/upgrade/nand.sh | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff mbox series

Patch

diff --git a/package/base-files/files/lib/upgrade/nand.sh b/package/base-files/files/lib/upgrade/nand.sh
index d910bf1791..7a6873e224 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"