comment should have function name as prefix

This commit is contained in:
yuzhiquan
2021-04-26 18:08:49 +08:00
parent d483872d64
commit bebca30309
5 changed files with 10 additions and 10 deletions

View File

@@ -95,7 +95,7 @@ type Runtime interface {
// that are terminated, but not deleted will be evicted. Otherwise, only deleted pods will be GC'd.
// TODO: Revisit this method and make it cleaner.
GarbageCollect(gcPolicy GCPolicy, allSourcesReady bool, evictNonDeletedPods bool) error
// Syncs the running pod into the desired pod.
// SyncPod syncs the running pod into the desired pod.
SyncPod(pod *v1.Pod, podStatus *PodStatus, pullSecrets []v1.Secret, backOff *flowcontrol.Backoff) PodSyncResult
// KillPod kills all the containers of a pod. Pod may be nil, running pod must not be.
// TODO(random-liu): Return PodSyncResult in KillPod.
@@ -112,7 +112,7 @@ type Runtime interface {
// stream the log. Set 'follow' to false and specify the number of lines (e.g.
// "100" or "all") to tail the log.
GetContainerLogs(ctx context.Context, pod *v1.Pod, containerID ContainerID, logOptions *v1.PodLogOptions, stdout, stderr io.Writer) (err error)
// Delete a container. If the container is still running, an error is returned.
// DeleteContainer deletes a container. If the container is still running, an error is returned.
DeleteContainer(containerID ContainerID) error
// ImageService provides methods to image-related methods.
ImageService
@@ -139,11 +139,11 @@ type ImageService interface {
// GetImageRef gets the reference (digest or ID) of the image which has already been in
// the local storage. It returns ("", nil) if the image isn't in the local storage.
GetImageRef(image ImageSpec) (string, error)
// Gets all images currently on the machine.
// ListImages gets all images currently on the machine.
ListImages() ([]Image, error)
// Removes the specified image.
// RemoveImage removes the specified image.
RemoveImage(image ImageSpec) error
// Returns Image statistics.
// ImageStats returns Image statistics.
ImageStats() (*ImageStats, error)
}