github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-07 11:13:48 +00:00
Code Issues Projects Releases Wiki Activity

convert README.md to doc.go

Browse Source
This commit is contained in:
Chao Xu 2016-08-03 16:38:29 -07:00
parent 8f4f682659
commit 4c7514be13
2 changed files with 28 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
pkg/util/net/sets/README.md
View File

@ -1,17 +0,0 @@
This package contains hand-coded set implementations that should be similar to
the autogenerated ones in `pkg/util/sets`.
We can't simply use net.IPNet as a map-key in Go (because it contains a
`[]byte`).
We could use the same workaround we use here (a string representation as the
key) to autogenerate sets. If we do that, or decide on an alternate approach,
we should replace the implementations in this package with the autogenerated
versions.
It is expected that callers will alias this import as `netsets`
i.e. `import netsets "k8s.io/kubernetes/pkg/util/net/sets"`
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/pkg/util/net/sets/README.md?pixel)]()

28
pkg/util/net/sets/doc.go Normal file
View File

@ -0,0 +1,28 @@
/*
Copyright 2016 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.
*/
// This package contains hand-coded set implementations that should be similar
// to the autogenerated ones in pkg/util/sets.
// We can't simply use net.IPNet as a map-key in Go (because it contains a
// []byte).
// We could use the same workaround we use here (a string representation as the
// key) to autogenerate sets. If we do that, or decide on an alternate
// approach, we should replace the implementations in this package with the
// autogenerated versions.
// It is expected that callers will alias this import as "netsets" i.e. import
// netsets "k8s.io/kubernetes/pkg/util/net/sets"
package sets