clear up comment about flush=false

License: MIT Signed-off-by: Jeromy <jeromyj@gmail.com>
ipfs · Feb 8, 2016 · 965fab4 · 965fab4
1 parent d11b7aa
commit 965fab4
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/core/commands/files/files.go b/core/commands/files/files.go
@@ -29,12 +29,12 @@ var FilesCmd = &cmds.Command{
 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.
+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 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{