Merge pull request #63 from monopole/packageDoc

Improve package structure and documentation.

pkg/app/application.go

@@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package app implements state for the set of all resources being customized.
+// Should rename this - there's nothing "app"y about it.
 package app
 
 import (

pkg/app/application_test.go

@@ -22,8 +22,8 @@ import (
 	"testing"
 
 	"github.com/kubernetes-sigs/kustomize/pkg/constants"
+	"github.com/kubernetes-sigs/kustomize/pkg/internal/loadertest"
 	"github.com/kubernetes-sigs/kustomize/pkg/loader"
-	"github.com/kubernetes-sigs/kustomize/pkg/loader/loadertest"
 	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
 	"github.com/kubernetes-sigs/kustomize/pkg/resource"
 	corev1 "k8s.io/api/core/v1"

pkg/commands/commands.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package commands holds the CLI glue mapping textual commands/args to method calls.
 package commands
 
 import (

pkg/configmapandsecret/configmap_secret.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package configmapandsecret generates configmaps and secrets per generator rules.
 package configmapandsecret
 
 import (

pkg/configmapandsecret/util/util.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package util offers Configmap and Secret generation utilities.
 package util
 
 import (

pkg/diff/doc.go

@@ -1,2 +0,0 @@
-// Package diff runs system diff to compare resource collections
-package diff

pkg/diff/rundiff.go

@@ -1,3 +1,20 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package diff runs system `diff` to compare resource collections.
 package diff
 
 import (

pkg/fs/fs.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package fs provides a file system abstraction layer.
 package fs
 
 import (

pkg/hash/hash.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package hash generates hash strings from configmaps and secrets.
 package hash
 
 import (

pkg/internal/loadertest/fakeloader.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package loadertest holds a fake for the Loader interface.
 package loadertest
 
 import (

pkg/loader/loader.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package loader has a data loading interface and various implementations.
 package loader
 
 import "fmt"

pkg/resmap/configmap_test.go

@@ -20,7 +20,7 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/kubernetes-sigs/kustomize/pkg/loader/loadertest"
+	"github.com/kubernetes-sigs/kustomize/pkg/internal/loadertest"
 	"github.com/kubernetes-sigs/kustomize/pkg/resource"
 	"github.com/kubernetes-sigs/kustomize/pkg/types"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"

pkg/resmap/resmap.go

@@ -1,3 +1,20 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package resmap implements a map from ResId to Resource that tracks all resources in a kustomization.
 package resmap
 
 import (
@@ -17,7 +34,7 @@ import (
 	k8syaml "k8s.io/apimachinery/pkg/util/yaml"
 )
 
-// ResMap is a map from ResId to Resource
+// ResMap is a map from ResId to Resource.
 type ResMap map[resource.ResId]*resource.Resource
 
 // EncodeAsYaml encodes a ResMap to YAML; encoded objects separated by `---`.

pkg/resmap/resmap_test.go

@@ -21,7 +21,7 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/kubernetes-sigs/kustomize/pkg/loader/loadertest"
+	"github.com/kubernetes-sigs/kustomize/pkg/internal/loadertest"
 	"github.com/kubernetes-sigs/kustomize/pkg/resource"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"

pkg/resource/resource.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package resource implements representations of k8s API resources as "unstructured" objects.
 package resource
 
 import (

pkg/transformers/transformer.go

@@ -14,12 +14,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package transformers has implementations of resmap.ResMap transformers.
 package transformers
 
 import "github.com/kubernetes-sigs/kustomize/pkg/resmap"
 
-// Transformer can transform objects.
+// A Transformer modifies an instance of resmap.ResMap.
 type Transformer interface {
-	// Transform modifies objects in a map, e.g. add prefixes or additional labels.
+	// Transform modifies data in the argument, e.g. adding labels to resources that can be labelled.
 	Transform(m resmap.ResMap) error
 }

pkg/types/kustomization.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package types holds struct definitions that should find a better home.
 package types
 
 // Kustomization holds the information needed to generate customized k8s api resources.