@@ -385,15 +385,20 @@ var updatePinCmd = &cmds.Command{
385
385
Helptext : cmds.HelpText {
386
386
Tagline : "Update a recursive pin" ,
387
387
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.
391
396
` ,
392
397
},
393
398
394
399
Arguments : []cmds.Argument {
395
400
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." ),
397
402
},
398
403
Options : []cmds.Option {
399
404
cmds .BoolOption (pinUnpinOptionName , "Remove the old pin." ).WithDefault (true ),
0 commit comments