Merge pull request #6882 from ipfs/fix/6878-mfs-docs

Fix #6878: Improve MFS Cli documentation

core/commands/files.go

@@ -39,6 +39,22 @@ var FilesCmd = &cmds.Command{
 Files is an API for manipulating IPFS objects as if they were a unix
 filesystem.
 
+The files facility interacts with MFS (Mutable File System). MFS acts as a
+single, dynamic filesystem mount. MFS has a root CID which is transparently
+updated when a change happens (and can be checked with "ipfs files stat /").
+
+All files and folders within MFS are respected and will not be cleaned up
+during garbage collections. MFS is independent from the list of pinned items
+("ipfs pin ls"). Calls to "ipfs pin add" and "ipfs pin rm" will add and remove
+pins independently of MFS. If MFS content that was
+additionally pinned is removed by calling "ipfs files rm", it will still
+remain pinned.
+
+Content added with "ipfs add" (which by default also becomes pinned), is not
+added to MFS. Any content can be put into MFS with the command "ipfs files cp
+/ipfs/<cid> /some/path/".
+
+
 NOTE:
 Most of the subcommands of 'ipfs files' accept the '--flush' flag. It defaults
 to true. Use caution when setting this flag to false. It will improve
@@ -762,7 +778,7 @@ stat' on the file or any of its ancestors.
 				if retErr == nil {
 					retErr = err
 				} else {
-					log.Error("files: error closing file mfs file descriptor", err)
+					flog.Error("files: error closing file mfs file descriptor", err)
 				}
 			}
 		}()