diff doc/Host-tools-overview @ 709:9b0ad72184e3

doc/Host-tools-overview: tiffs-mkfs documented
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 23 May 2020 03:16:21 +0000
parents 46d17c346511
children 098fea21ba13
line wrap: on
line diff
--- a/doc/Host-tools-overview	Sat May 23 02:50:06 2020 +0000
+++ b/doc/Host-tools-overview	Sat May 23 03:16:21 2020 +0000
@@ -256,3 +256,13 @@
 		FFS modifications.  tiffs is the main program, whereas mokoffs
 		and pirffs are convenience wrappers for the common FFS
 		configurations from Openmoko and Pirelli.
+
+tiffs-mkfs	This utility constructs a TI flash file system (TIFFS) image
+		completely from scratch "in vitro", containing initial directory
+		and file content given by a Unix directory and file tree on the
+		host system.  The resulting image can then be flashed into a
+		Calypso GSM device running FreeCalypso firmware.  Please note
+		that FFS images made with tiffs-mkfs are acceptable ONLY to
+		FreeCalypso firmware versions as of 2020-05-22 or later (prior
+		versions contain a bug in their handling of journal creation on
+		boot), and are NOT approved for use with any non-FC firmwares.