doc: Add high-level doc for the config and vf packages

cfergeau · cfergeau · commit 2354c6e7fed9 · 2024-10-01T10:35:18.000+02:00
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -1,3 +1,14 @@
+// Package config provides native go data types to describe a VM configuration
+// (memory, CPUs, bootloader, devices, ...).
+// It's used by vfkit which generates a VirtualMachine instance after parsing
+// its command line using FromOptions().
+// It can also be used by application writers who want to start a VM with
+// vfkit. After creating a VirtualMachine instance with the needed devices,
+// calling VirtualMachine.Cmd() will return an exec.Cmd which can be used
+// to start the virtual machine.
+//
+// This package does not use Code-Hex/vz directly as it must possible to
+// cross-compile code using it.
 package config
 
 import (
diff --git a/pkg/vf/virtio.go b/pkg/vf/virtio.go
@@ -13,6 +13,9 @@ import (
 	"golang.org/x/sys/unix"
 )
 
+// vf will define toVZ() and AddToVirtualMachineConfig() methods on these types
+// We alias the types from the config package to avoid duplicating struct
+// definitions between the config and vf packages
 type RosettaShare config.RosettaShare
 type NVMExpressController config.NVMExpressController
 type VirtioBlk config.VirtioBlk
diff --git a/pkg/vf/vm.go b/pkg/vf/vm.go
@@ -1,3 +1,10 @@
+// Package vf converts a config.VirtualMachine configuration to native
+// virtualization framework datatypes. It also provides APIs to start/stop/...
+// the virtualization framework virtual machine.
+//
+// The interaction with the virtualization framework is done using the
+// Code-Hex/vz Objective-C bindings. This requires cgo, and this package cannot
+// be easily cross-compiled, it must be built on macOS.
 package vf
 
 import (

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@ import (`
`13`	`13`	`"golang.org/x/sys/unix"`
`14`	`14`	`)`
`15`	`15`
	`16`	`+// vf will define toVZ() and AddToVirtualMachineConfig() methods on these types`
	`17`	`+// We alias the types from the config package to avoid duplicating struct`
	`18`	`+// definitions between the config and vf packages`
`16`	`19`	`type RosettaShare config.RosettaShare`
`17`	`20`	`type NVMExpressController config.NVMExpressController`
`18`	`21`	`type VirtioBlk config.VirtioBlk`