@@ -539,15 +539,20 @@ var updatePinCmd = &cmds.Command{
539
539
Helptext : cmds.HelpText {
540
540
Tagline : "Update a recursive pin" ,
541
541
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.
545
550
` ,
546
551
},
547
552
548
553
Arguments : []cmds.Argument {
549
554
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." ),
551
556
},
552
557
Options : []cmds.Option {
553
558
cmds .BoolOption (pinUnpinOptionName , "Remove the old pin." ).WithDefault (true ),
0 commit comments