github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Fix out of date comments for CRI store packages

Browse Source 
All of the CRI store related packages all use the standard errdefs
errors now for if a key doesn't or already exists (ErrAlreadyExists,
ErrNotFound), but the comments for the methods still referenced
some unused package specific error definitions. This change just
updates the comments to reflect what errors are actually returned
and adds comments for some previously undocumented exported functions.

Signed-off-by: Daniel Canter <dcanter@microsoft.com>
This commit is contained in:
Daniel Canter
2022-07-11 13:53:11 -07:00
parent de4e2e11d4
commit bcdc8468f8
5 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
pkg/cri/store/container/container.go
View File

@@ -122,7 +122,7 @@ func NewStore(labels *label.Store) *Store {
}
}
// Add a container into the store. Returns store.ErrAlreadyExist if the
// Add a container into the store. Returns errdefs.ErrAlreadyExists if the
// container already exists.
func (s *Store) Add(c Container) error {
s.lock.Lock()
@@ -140,7 +140,7 @@ func (s *Store) Add(c Container) error {
return nil
}
// Get returns the container with specified id. Returns store.ErrNotExist
// Get returns the container with specified id. Returns errdefs.ErrNotFound
// if the container doesn't exist.
func (s *Store) Get(id string) (Container, error) {
s.lock.RLock()
@@ -169,6 +169,9 @@ func (s *Store) List() []Container {
return containers
}
// UpdateContainerStats updates the container specified by ID with the
// stats present in 'newContainerStats'. Returns errdefs.ErrNotFound
// if the container does not exist in the store.
func (s *Store) UpdateContainerStats(id string, newContainerStats *stats.ContainerStats) error {
s.lock.Lock()
defer s.lock.Unlock()