# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1580796655 0
# Node ID 3a9b8f9c722581d81ae46a5bfddc2ac39c9521fa
# Parent  e6fe9d25377a64963b898f490cc17aa7143c95fc
fc-fsio help: cleandir and rm-subtree additions documented

diff -r e6fe9d25377a -r 3a9b8f9c7225 rvinterf/etmsync/fsio.help
--- a/rvinterf/etmsync/fsio.help	Tue Feb 04 05:30:59 2020 +0000
+++ b/rvinterf/etmsync/fsio.help	Tue Feb 04 06:10:55 2020 +0000
@@ -2,6 +2,7 @@
 === all
 The following commands are available:
 
+cleandir		Clean FFS directory
 cpout			Copy content out of device FFS to host file system
 cpout-file		Copy out a single file
 dieid			Retrieve Calypso die ID via ETM query
@@ -23,6 +24,7 @@
 preformat		Preformat FFS on device (dangerous!)
 readlink		Raw interface to ffs_readlink() API call
 rm			Delete FFS object
+rm-subtree		Delete FFS directory subtree
 set-imeisv		Write /etc/IMEISV or /pcm/IMEI file
 set-pcm-string		Write /pcm/CGxx files
 set-rfcap		Write /gsm/com/rfcap file
@@ -41,6 +43,17 @@
 communicates has no notion of a current directory, hence all target side
 FFS pathnames must be absolute.
 
+=== cleandir
+cleandir ffs-pathname
+
+This command deletes all files and subdirectories contained in the named FFS
+directory, leaving an empty directory; the named FFS directory must exist.
+
+This command is primarily intended for cleaning out the /mmi directory when
+experimenting with different UI firmware versions, or after loading AT command
+modem firmware into a device which previously ran some fw version with UI layers
+included.
+
 === cpout
 cpout target-pathname host-pathname
 
@@ -217,6 +230,16 @@
 If the -f option is given, the condition where the object to be deleted does not
 exist is treated as not-an-error; all other errors are still reported.
 
+=== rm-subtree
+rm-subtree [-f] ffs-pathname
+
+This command deletes an entire subtree of directories and files in the target
+device FFS, starting with the specified pathname which must be a directory, not
+a regular file or symlink.  It is an approximate equivalent of rm -r in UNIX.
+
+If the -f option is given, the condition where the top directory to be deleted
+does not exist is treated as not-an-error; all other errors are still reported.
+
 === set-imeisv
 set-imeisv fc  XXXXXXXX-YYYYYY-ZZ	# write /etc/IMEISV
 set-imeisv pcm XXXXXXXX-YYYYYY-ZZ	# write /pcm/IMEI