Skip to content

Commit edf0160

Browse files
committed
pkg/instance: improve comment about returned errors
We return pointers rather than structs directly, this is important if the errors are casted.
1 parent a066d2b commit edf0160

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pkg/instance/instance.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ func (err *CrashError) Error() string {
256256
}
257257

258258
// Test boots numVMs VMs, tests basic kernel operation, and optionally tests the provided reproducer.
259-
// TestError is returned if there is a problem with kernel/image (crash, reboot loop, etc).
260-
// CrashError is returned if the reproducer crashes kernel.
259+
// *TestError is returned if there is a problem with kernel/image (crash, reboot loop, etc).
260+
// *CrashError is returned if the reproducer crashes kernel.
261261
func (env *env) Test(numVMs int, reproSyz, reproOpts, reproC []byte) ([]EnvTestResult, error) {
262262
if env.testSem != nil {
263263
env.testSem.Wait()

0 commit comments

Comments
 (0)