Merge pull request #2423 from justinsb/fix_mergefilter_docs

Fix godocs on MergeFilter
This commit is contained in:
Jeff Regan
2020-04-29 15:36:29 -07:00
committed by GitHub

View File

@@ -5,11 +5,12 @@
package filters package filters
import ( import (
"sigs.k8s.io/kustomize/kyaml/kio"
"sigs.k8s.io/kustomize/kyaml/yaml" "sigs.k8s.io/kustomize/kyaml/yaml"
"sigs.k8s.io/kustomize/kyaml/yaml/merge2" "sigs.k8s.io/kustomize/kyaml/yaml/merge2"
) )
// GrepFilter merges Resources with the Group/Version/Kind/Namespace/Name together using // MergeFilter merges Resources with the Group/Version/Kind/Namespace/Name together using
// a 2-way merge strategy. // a 2-way merge strategy.
// //
// - Fields set to null in the source will be cleared from the destination // - Fields set to null in the source will be cleared from the destination
@@ -20,6 +21,8 @@ type MergeFilter struct {
Reverse bool Reverse bool
} }
var _ kio.Filter = MergeFilter{}
type mergeKey struct { type mergeKey struct {
apiVersion string apiVersion string
kind string kind string
@@ -27,7 +30,7 @@ type mergeKey struct {
name string name string
} }
// GrepFilter implements kio.GrepFilter by merge Resources with the same G/V/K/NS/N // MergeFilter implements kio.Filter by merging Resources with the same G/V/K/NS/N
func (c MergeFilter) Filter(input []*yaml.RNode) ([]*yaml.RNode, error) { func (c MergeFilter) Filter(input []*yaml.RNode) ([]*yaml.RNode, error) {
// invert the merge precedence // invert the merge precedence
if c.Reverse { if c.Reverse {