add note about flush flag
License: MIT Signed-off-by: Jeromy <jeromyj@gmail.com>
Jeromy committed
Jan 15, 2016 at 09:57 UTC
829606a9ede28b348803dc196107e06fceeaeb31
1 file changed
+8
core/commands/files/files.go
+8
@@ -27,6 +27,14 @@ var FilesCmd = &cmds.Command{
27
Tagline: "Manipulate unixfs files.",
28
ShortDescription: `
29
Files is an API for manipulating ipfs objects as if they were a unix filesystem.
30
+
31
+Note:
32
+Most of the subcommands of 'ipfs files' accept the '--flush' flag. Use caution
33
+when using this flag, It will improve performance for large numbers of file
34
+operations, but it does so at the cost of consistency guarantees. If the daemon
35
+is unexpectedly killed before running 'ipfs files flush' on the files in question,
36
+then data may be lost. This also applies to running 'ipfs repo gc' concurrently
37
+with '--flush=false' operations.
38
`,
39
},
40
Options: []cmds.Option{