Merge pull request #4281 from r4f4/runtime-qemu-comments

runtime: sync docstrings with function names
This commit is contained in:
Chelsea Mafrica
2022-05-19 09:17:38 -07:00
committed by GitHub
4 changed files with 21 additions and 21 deletions

View File

@@ -798,7 +798,7 @@ func (q *qemu) setupVirtioMem(ctx context.Context) error {
return err
}
// startSandbox will start the Sandbox's VM.
// StartVM will start the Sandbox's VM.
func (q *qemu) StartVM(ctx context.Context, timeout int) error {
span, ctx := katatrace.Trace(ctx, q.Logger(), "StartVM", qemuTracingTags, map[string]string{"sandbox_id": q.id})
defer span.End()
@@ -970,7 +970,7 @@ func (q *qemu) waitVM(ctx context.Context, timeout int) error {
return nil
}
// stopSandbox will stop the Sandbox's VM.
// StopVM will stop the Sandbox's VM.
func (q *qemu) StopVM(ctx context.Context, waitOnly bool) error {
span, _ := katatrace.Trace(ctx, q.Logger(), "StopVM", qemuTracingTags, map[string]string{"sandbox_id": q.id})
defer span.End()
@@ -2040,7 +2040,7 @@ func (q *qemu) ResumeVM(ctx context.Context) error {
return q.togglePauseSandbox(ctx, false)
}
// addDevice will add extra devices to Qemu command line.
// AddDevice will add extra devices to Qemu command line.
func (q *qemu) AddDevice(ctx context.Context, devInfo interface{}, devType DeviceType) error {
var err error
span, _ := katatrace.Trace(ctx, q.Logger(), "AddDevice", qemuTracingTags)
@@ -2099,8 +2099,8 @@ func (q *qemu) AddDevice(ctx context.Context, devInfo interface{}, devType Devic
return err
}
// getSandboxConsole builds the path of the console where we can read
// logs coming from the sandbox.
// GetVMConsole builds the path of the console where we can read logs coming
// from the sandbox.
func (q *qemu) GetVMConsole(ctx context.Context, id string) (string, string, error) {
span, _ := katatrace.Trace(ctx, q.Logger(), "GetVMConsole", qemuTracingTags, map[string]string{"sandbox_id": q.id})
defer span.End()
@@ -2173,7 +2173,7 @@ func (q *qemu) Disconnect(ctx context.Context) {
q.qmpShutdown()
}
// resizeMemory get a request to update the VM memory to reqMemMB
// ResizeMemory gets a request to update the VM memory to reqMemMB
// Memory update is managed with two approaches
// Add memory to VM:
// When memory is required to be added we hotplug memory