Skip to content

Commit 146d9d2

Browse files
committed
Improve pin/update description
I was unable to actually understand what pin update does from the existing description. License: MIT Signed-off-by: Hector Sanjuan <[email protected]>
1 parent cd2611d commit 146d9d2

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
@@ -385,15 +385,20 @@ var updatePinCmd = &cmds.Command{
385385
Helptext: cmds.HelpText{
386386
Tagline: "Update a recursive pin",
387387
ShortDescription: `
388-
Updates one pin to another, making sure that all objects in the new pin are
389-
local. Then removes the old pin. This is an optimized version of adding the
390-
new pin and removing the old one.
388+
Efficiently pins a new object based on differences from an existing one and,
389+
by default, removes the old pin.
390+
391+
This commands is useful when the new pin contains many similarities or is a
392+
derivate of an existing one, particuarly for large objects. This allows a more
393+
efficient DAG-traversal which fully skips already-pinned branches from the old
394+
object. As a requirement, the old object needs to be an existing recursive
395+
pin.
391396
`,
392397
},
393398

394399
Arguments: []cmds.Argument{
395400
cmds.StringArg("from-path", true, false, "Path to old object."),
396-
cmds.StringArg("to-path", true, false, "Path to new object to be pinned."),
401+
cmds.StringArg("to-path", true, false, "Path to a new object to be pinned."),
397402
},
398403
Options: []cmds.Option{
399404
cmds.BoolOption(pinUnpinOptionName, "Remove the old pin.").WithDefault(true),

0 commit comments

Comments
 (0)