Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #6878: Improve MFS Cli documentation #6882

Merged
merged 5 commits into from
Feb 7, 2020
Merged

Fix #6878: Improve MFS Cli documentation #6882

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da584b8
Fix #6878: Improve MFS Cli documentation
hsanjuan Feb 7, 2020
10194de
core/commands/files: log.Error -> flog.Error
hsanjuan Feb 7, 2020
e05ddfa
/mfs/path -> /some/path
hsanjuan Feb 7, 2020
38ca2fb
core/commands/files: MFS docs, minor improvements after user feedback
hsanjuan Feb 7, 2020
effbc0a
docs(commands): fix mfs wording
Stebalien Feb 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion core/commands/files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
an separate pin independent of the content on MFS. If MFS content that was
Stebalien marked this conversation as resolved.
Show resolved Hide resolved
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
Expand Down Expand Up @@ -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)
}
}
}()
Expand Down