Merge pull request #286 from AkihiroSuda/nits-20211004

nits

Author: AkihiroSuda

README.md

@@ -101,7 +101,9 @@ Install recent version of QEMU. v6.1.0 or later is recommended.
 
 On ARM hosts, a [patched](https://patchwork.kernel.org/series/548227/mbox/) version of QEMU has to be installed for enabling `-accel hvf` support.
 
-The patch is not merged into the QEMU upstream yet as of QEMU v6.1.0, but already included in [the Homebrew package of QEMU](https://github.com/Homebrew/homebrew-core/commit/5e8eb547) since `6.1.0_1` bottle.
+The patch was merged into the master branch on [2021-09-21](https://github.com/qemu/qemu/commit/81ceb36b9) and will be included in QEMU v6.2.0.
+
+The patch is already cherry-picked in [the Homebrew package of QEMU](https://github.com/Homebrew/homebrew-core/commit/5e8eb547) since `6.1.0_1` bottle.
 
 #### Install Lima
 

cmd/limactl/main.go

@@ -2,7 +2,9 @@ package main
 
 import (
 	"errors"
+	"fmt"
 	"os"
+	"path/filepath"
 	"strings"
 
 	"github.com/lima-vm/lima/pkg/store/dirnames"
@@ -23,10 +25,30 @@ func main() {
 }
 
 func newApp() *cobra.Command {
+	examplesDir := "$PREFIX/share/doc/lima/examples"
+	if exe, err := os.Executable(); err == nil {
+		binDir := filepath.Dir(exe)
+		prefixDir := filepath.Dir(binDir)
+		examplesDir = filepath.Join(prefixDir, "share/doc/lima/examples")
+	}
+
 	var rootCmd = &cobra.Command{
-		Use:           "limactl",
-		Short:         "Lima: Linux virtual machines",
-		Version:       strings.TrimPrefix(version.Version, "v"),
+		Use:     "limactl",
+		Short:   "Lima: Linux virtual machines",
+		Version: strings.TrimPrefix(version.Version, "v"),
+		Example: fmt.Sprintf(`  Start the default instance:
+  $ limactl start
+
+  Open a shell:
+  $ lima
+
+  Run a container:
+  $ lima nerdctl run -d --name nginx -p 8080:80 nginx:alpine
+
+  Stop the default instance:
+  $ limactl stop
+
+  See also example YAMLs: %s`, examplesDir),
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/limactl/stop.go

@@ -10,8 +10,8 @@ import (
 	"syscall"
 	"time"
 
-	hostagentapi "github.com/lima-vm/lima/pkg/hostagent/api"
-	"github.com/lima-vm/lima/pkg/networks/reconcile"
+	hostagentevents "github.com/lima-vm/lima/pkg/hostagent/events"
+	networks "github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 	"github.com/sirupsen/logrus"
@@ -22,7 +22,7 @@ func newStopCommand() *cobra.Command {
 	var stopCmd = &cobra.Command{
 		Use:               "stop INSTANCE",
 		Short:             "Stop an instance",
-		Args:              cobra.ExactArgs(1),
+		Args:              cobra.MaximumNArgs(1),
 		RunE:              stopAction,
 		ValidArgsFunction: stopBashComplete,
 	}
@@ -32,9 +32,9 @@ func newStopCommand() *cobra.Command {
 }
 
 func stopAction(cmd *cobra.Command, args []string) error {
-	instName := args[0]
-	if instName == "" {
-		instName = DefaultInstanceName
+	instName := DefaultInstanceName
+	if len(args) > 0 {
+		instName = args[0]
 	}
 
 	inst, err := store.Inspect(instName)
@@ -78,7 +78,7 @@ func waitForHostAgentTermination(ctx context.Context, inst *store.Instance, begi
 	defer cancel()
 
 	var receivedExitingEvent bool
-	onEvent := func(ev hostagentapi.Event) bool {
+	onEvent := func(ev hostagentevents.Event) bool {
 		if len(ev.Status.Errors) > 0 {
 			logrus.Errorf("%+v", ev.Status.Errors)
 		}
@@ -92,7 +92,7 @@ func waitForHostAgentTermination(ctx context.Context, inst *store.Instance, begi
 	haStdoutPath := filepath.Join(inst.Dir, filenames.HostAgentStdoutLog)
 	haStderrPath := filepath.Join(inst.Dir, filenames.HostAgentStderrLog)
 
-	if err := hostagentapi.WatchEvents(ctx2, haStdoutPath, haStderrPath, begin, onEvent); err != nil {
+	if err := hostagentevents.Watch(ctx2, haStdoutPath, haStderrPath, begin, onEvent); err != nil {
 		return err
 	}
 

docs/internal.md

@@ -50,7 +50,7 @@ Guest agent:
 
 Host agent:
 - `ha.pid`: hostagent PID
-- `ha.stdout.log`: hostagent stdout (JSON lines, see `pkg/hostagent/api.Events`)
+- `ha.stdout.log`: hostagent stdout (JSON lines, see `pkg/hostagent/events.Event`)
 - `ha.stderr.log`: hostagent stderr (human-readable messages)
 
 ## Lima cache directory (`~/Library/Caches/lima`)

pkg/hostagent/api/api.go renamed to pkg/hostagent/events/events.go

@@ -1,4 +1,4 @@
-package api
+package events
 
 import (
 	"time"

pkg/hostagent/api/eventwatcher.go renamed to pkg/hostagent/events/watcher.go

@@ -1,4 +1,4 @@
-package api
+package events
 
 import (
 	"context"
@@ -10,7 +10,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-func WatchEvents(ctx context.Context, haStdoutPath, haStderrPath string, begin time.Time, onEvent func(Event) bool) error {
+func Watch(ctx context.Context, haStdoutPath, haStderrPath string, begin time.Time, onEvent func(Event) bool) error {
 	haStdoutTail, err := tail.TailFile(haStdoutPath,
 		tail.Config{
 			Follow:    true,

pkg/hostagent/hostagent.go

@@ -19,7 +19,7 @@ import (
 	"github.com/hashicorp/go-multierror"
 	guestagentapi "github.com/lima-vm/lima/pkg/guestagent/api"
 	guestagentclient "github.com/lima-vm/lima/pkg/guestagent/api/client"
-	hostagentapi "github.com/lima-vm/lima/pkg/hostagent/api"
+	"github.com/lima-vm/lima/pkg/hostagent/events"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/qemu"
 	"github.com/lima-vm/lima/pkg/sshutil"
@@ -114,7 +114,7 @@ func New(instName string, stdout, stderr io.Writer, sigintCh chan os.Signal) (*H
 	return a, nil
 }
 
-func (a *HostAgent) emitEvent(ctx context.Context, ev hostagentapi.Event) {
+func (a *HostAgent) emitEvent(ctx context.Context, ev events.Event) {
 	a.eventEncMu.Lock()
 	defer a.eventEncMu.Unlock()
 	if ev.Time.IsZero() {
@@ -135,8 +135,8 @@ func logPipeRoutine(l *logrus.Logger, r io.Reader, header string) {
 
 func (a *HostAgent) Run(ctx context.Context) error {
 	defer func() {
-		exitingEv := hostagentapi.Event{
-			Status: hostagentapi.Status{
+		exitingEv := events.Event{
+			Status: events.Status{
 				Exiting: true,
 			},
 		}
@@ -177,11 +177,11 @@ func (a *HostAgent) Run(ctx context.Context) error {
 	if sshLocalPort < 0 {
 		return fmt.Errorf("invalid ssh local port %d", sshLocalPort)
 	}
-	stBase := hostagentapi.Status{
+	stBase := events.Status{
 		SSHLocalPort: sshLocalPort,
 	}
 	stBooting := stBase
-	a.emitEvent(ctx, hostagentapi.Event{Status: stBooting})
+	a.emitEvent(ctx, events.Event{Status: stBooting})
 
 	go func() {
 		stRunning := stBase
@@ -190,7 +190,7 @@ func (a *HostAgent) Run(ctx context.Context) error {
 			stRunning.Errors = append(stRunning.Errors, haErr.Error())
 		}
 		stRunning.Running = true
-		a.emitEvent(ctx, hostagentapi.Event{Status: stRunning})
+		a.emitEvent(ctx, events.Event{Status: stRunning})
 	}()
 
 	for {

pkg/start/start.go

@@ -10,7 +10,7 @@ import (
 	"time"
 
 	"github.com/lima-vm/lima/pkg/cidata"
-	hostagentapi "github.com/lima-vm/lima/pkg/hostagent/api"
+	hostagentevents "github.com/lima-vm/lima/pkg/hostagent/events"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/qemu"
 	"github.com/lima-vm/lima/pkg/store"
@@ -72,10 +72,16 @@ func Start(ctx context.Context, inst *store.Instance) error {
 	}
 	// no defer haStderrW.Close()
 
-	haCmd := exec.CommandContext(ctx, self,
+	var args []string
+	if logrus.GetLevel() >= logrus.DebugLevel {
+		args = append(args, "--debug")
+	}
+	args = append(args,
 		"hostagent",
 		"--pidfile", haPIDPath,
 		inst.Name)
+	haCmd := exec.CommandContext(ctx, self, args...)
+
 	haCmd.Stdout = haStdoutW
 	haCmd.Stderr = haStderrW
 
@@ -134,7 +140,7 @@ func watchHostAgentEvents(ctx context.Context, instName, haStdoutPath, haStderrP
 		receivedRunningEvent bool
 		err                  error
 	)
-	onEvent := func(ev hostagentapi.Event) bool {
+	onEvent := func(ev hostagentevents.Event) bool {
 		if !printedSSHLocalPort && ev.Status.SSHLocalPort != 0 {
 			logrus.Infof("SSH Local Port: %d", ev.Status.SSHLocalPort)
 			printedSSHLocalPort = true
@@ -161,7 +167,7 @@ func watchHostAgentEvents(ctx context.Context, instName, haStdoutPath, haStderrP
 		return false
 	}
 
-	if xerr := hostagentapi.WatchEvents(ctx2, haStdoutPath, haStderrPath, begin, onEvent); xerr != nil {
+	if xerr := hostagentevents.Watch(ctx2, haStdoutPath, haStderrPath, begin, onEvent); xerr != nil {
 		return xerr
 	}