Skip to content

GitLab

Commit c908a059 authored by Edgar Lee's avatar Edgar Lee
Browse files
Options

Update Pin.RmRecursive docs to clarify shared indirect pins are not removed

parent 9ebc1123
Show whitespace changes
Inline Side-by-side
Showing with 3 additions and 1 deletion
options/pin.go
View file @ c908a059
...@@ -127,7 +127,9 @@ func (pinOpts) Recursive(recursive bool) PinAddOption { ...@@ -127,7 +127,9 @@ func (pinOpts) Recursive(recursive bool) PinAddOption {
} }
} }
// RmRecursive is an option for Pin.Rm // RmRecursive is an option for Pin.Rm which specifies whether to recursively
// unpin the object linked to by the specified object(s). This does not remove
// indirect pins referenced by other recursive pins.
func (pinOpts) RmRecursive(recursive bool) PinRmOption { func (pinOpts) RmRecursive(recursive bool) PinRmOption {
return func(settings *PinRmSettings) error { return func(settings *PinRmSettings) error {
settings.Recursive = recursive settings.Recursive = recursive
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment