Skip to content

Commit dc56b52

Browse files
authored
Merge pull request #6501 from ipfs/docs/pin/update
Improve pin/update description
2 parents 20e64ae + 146d9d2 commit dc56b52

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

core/commands/pin.go

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -539,15 +539,20 @@ var updatePinCmd = &cmds.Command{
539539
Helptext: cmds.HelpText{
540540
Tagline: "Update a recursive pin",
541541
ShortDescription: `
542-
Updates one pin to another, making sure that all objects in the new pin are
543-
local. Then removes the old pin. This is an optimized version of adding the
544-
new pin and removing the old one.
542+
Efficiently pins a new object based on differences from an existing one and,
543+
by default, removes the old pin.
544+
545+
This commands is useful when the new pin contains many similarities or is a
546+
derivate of an existing one, particuarly for large objects. This allows a more
547+
efficient DAG-traversal which fully skips already-pinned branches from the old
548+
object. As a requirement, the old object needs to be an existing recursive
549+
pin.
545550
`,
546551
},
547552

548553
Arguments: []cmds.Argument{
549554
cmds.StringArg("from-path", true, false, "Path to old object."),
550-
cmds.StringArg("to-path", true, false, "Path to new object to be pinned."),
555+
cmds.StringArg("to-path", true, false, "Path to a new object to be pinned."),
551556
},
552557
Options: []cmds.Option{
553558
cmds.BoolOption(pinUnpinOptionName, "Remove the old pin.").WithDefault(true),

0 commit comments

Comments
 (0)