From da584b867923ffd89a5404625279601bfe54740e Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Fri, 7 Feb 2020 14:55:01 +0100 Subject: [PATCH] Fix #6878: Improve MFS Cli documentation --- core/commands/files.go | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/core/commands/files.go b/core/commands/files.go index e568657d644..54e89f7fb02 100644 --- a/core/commands/files.go +++ b/core/commands/files.go @@ -39,6 +39,18 @@ 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" do not affect +content on MFS. Similarly, content added with "ipfs add" (which by default +pins), is not added to MFS. Any content can be put into MFS with the command +"ipfs files cp /ipfs/ /mfs/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