Merge pull request #265 from AkihiroSuda/vmnet-nits

vmnet nits

Author: AkihiroSuda

cmd/limactl/sudoers.go

@@ -3,16 +3,25 @@ package main
 import (
 	"errors"
 	"fmt"
+	"os"
+	"path/filepath"
 	"runtime"
 
 	"github.com/lima-vm/lima/pkg/networks"
 	"github.com/spf13/cobra"
 )
 
 func newSudoersCommand() *cobra.Command {
+	networksMD := "$PREFIX/share/doc/lima/docs/network.md"
+	if exe, err := os.Executable(); err == nil {
+		binDir := filepath.Dir(exe)
+		prefixDir := filepath.Dir(binDir)
+		networksMD = filepath.Join(prefixDir, "share/doc/lima/docs/network.md")
+	}
 	sudoersCommand := &cobra.Command{
 		Use:   "sudoers [SUDOERSFILE]",
-		Short: "Generate /etc/sudoers.d/lima file.",
+		Short: "Generate /etc/sudoers.d/lima file for enabling vmnet.framework support",
+		Long:  fmt.Sprintf("Generate /etc/sudoers.d/lima file for enabling vmnet.framework support.\nSee %s for the usage.", networksMD),
 		Args:  cobra.MaximumNArgs(1),
 		RunE:  sudoersAction,
 	}
@@ -67,4 +76,4 @@ func verifySudoAccess(args []string) error {
 	}
 	fmt.Printf("%q is up-to-date (or sudo doesn't require a password)\n", file)
 	return nil
-}
+}

examples/vmnet.yaml

@@ -1,3 +1,6 @@
+# Example to enable vmnet.framework
+# This example requires Lima v0.7.0 or later.
+# Older versions of Lima were using a different syntax for supporting vmnet.framework.
 images:
   # Hint: run `limactl prune` to invalidate the "current" cache
   - location: "https://cloud-images.ubuntu.com/hirsute/current/hirsute-server-cloudimg-amd64.img"