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

8
pkg/cri/store/sandbox/sandbox.go
View File

@@ -78,7 +78,8 @@ func NewStore(labels *label.Store) *Store {
}
}
// Add a sandbox into the store.
// Add a sandbox into the store. Returns errdefs.ErrAlreadyExists if the sandbox is
// already stored.
func (s *Store) Add(sb Sandbox) error {
s.lock.Lock()
defer s.lock.Unlock()
@@ -96,7 +97,7 @@ func (s *Store) Add(sb Sandbox) error {
}
// Get returns the sandbox with specified id.
// Returns store.ErrNotExist if the sandbox doesn't exist.
// Returns errdefs.ErrNotFound if the sandbox doesn't exist.
func (s *Store) Get(id string) (Sandbox, error) {
s.lock.RLock()
defer s.lock.RUnlock()
@@ -124,6 +125,9 @@ func (s *Store) List() []Sandbox {
return sandboxes
}
// UpdateContainerStats updates the sandbox specified by ID with the
// stats present in 'newContainerStats'. Returns errdefs.ErrNotFound
// if the sandbox does not exist in the store.
func (s *Store) UpdateContainerStats(id string, newContainerStats *stats.ContainerStats) error {
s.lock.RLock()
defer s.lock.RUnlock()