From a213edae2a6226db92a5be9c6064b4cba4da20e3 Mon Sep 17 00:00:00 2001 From: matte21 Date: Sat, 16 Sep 2023 21:59:30 -0400 Subject: [PATCH] Add package-level godoc to pkg/kubelet/cm Add file doc.go with some rudimentary information to package kubelet/cm. This will make it easier for people approaching the kubelet codebase for the first time to quickly understand what's in the package, since its name is abbreviated and hostile to newcomers. --- pkg/kubelet/cm/doc.go | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 pkg/kubelet/cm/doc.go diff --git a/pkg/kubelet/cm/doc.go b/pkg/kubelet/cm/doc.go new file mode 100644 index 00000000000..422aca0750b --- /dev/null +++ b/pkg/kubelet/cm/doc.go @@ -0,0 +1,21 @@ +/* +Copyright 2023 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 cm (abbreviation of "container manager") and its subpackages contain all the kubelet code +// to manage containers. For example, they contain functions to configure containers' cgroups, +// ensure containers run with the desired QoS, and allocate compute resources like cpus, memory, +// devices... +package cm // import "k8s.io/kubernetes/pkg/kubelet/cm"