ipfs files cp: improve docstring with better words.
And align capitalization.
Hector Sanjuan committed
Apr 2, 2020 at 20:46 UTC
3b30e8e2b00ddaeffe8702c132aa6263fdf3e472
1 file changed
+6
-6
core/commands/files.go
+6
-6
@@ -321,10 +321,10 @@ func walkBlock(ctx context.Context, dagserv ipld.DAGService, nd ipld.Node) (bool
321
322
var filesCpCmd = &cmds.Command{
323
Helptext: cmds.HelpText{
324
- Tagline: "Copy any IPFS objects into mfs (or copy within MFS).",
324
+ Tagline: "Copy any IPFS files and directories into MFS (or copy within MFS).",
325
ShortDescription: `
326
-"ipfs files cp" can be used to copy any IPFS object (usually in the form
327
-/ipfs/<CID>, but also any resolvable path), into the Mutable File System
326
+"ipfs files cp" can be used to copy any IPFS file or directory (usually in the
327
+form /ipfs/<CID>, but also any resolvable path), into the Mutable File System
328
(MFS).
329
330
It can also be used to copy files within MFS, but in the case when an
@@ -333,15 +333,15 @@ IPFS-path matches an existing MFS path, the IPFS path wins.
333
In order to add content to MFS from disk, you can use "ipfs add" to obtain the
334
IPFS Content Identifier and then "ipfs files cp" to copy it into MFS:
335
336
-$ ipfs add --pin=false <your file>
336
+$ ipfs add --quieter --pin=false <your file>
337
# ...
338
# ... outputs the root CID at the end
339
$ ipfs cp /ipfs/<CID> /your/desired/mfs/path
340
`,
341
},
342
Arguments: []cmds.Argument{
343
- cmds.StringArg("source", true, false, "Source object to copy."),
344
- cmds.StringArg("dest", true, false, "Destination to copy object to."),
343
+ cmds.StringArg("source", true, false, "Source IPFS or MFS path to copy."),
344
+ cmds.StringArg("dest", true, false, "Destination within MFS."),
345
},
346
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
347
nd, err := cmdenv.GetNode(env)