Commit 829606a9 authored by Jeromy's avatar Jeromy

add note about flush flag

License: MIT
Signed-off-by: default avatarJeromy <jeromyj@gmail.com>
parent b078915f
......@@ -27,6 +27,14 @@ var FilesCmd = &cmds.Command{
Tagline: "Manipulate unixfs files.",
ShortDescription: `
Files is an API for manipulating ipfs objects as if they were a unix filesystem.
Note:
Most of the subcommands of 'ipfs files' accept the '--flush' flag. Use caution
when using this flag, It will improve performance for large numbers of file
operations, but it does so at the cost of consistency guarantees. If the daemon
is unexpectedly killed before running 'ipfs files flush' on the files in question,
then data may be lost. This also applies to running 'ipfs repo gc' concurrently
with '--flush=false' operations.
`,
},
Options: []cmds.Option{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment