mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-17 22:34:25 +01:00
qemu: Add package documentation
This commit adds some package documentation to the qemu package, including an overview of the package and an example of its use. Signed-off-by: Mark Ryan <mark.d.ryan@intel.com>
This commit is contained in:
8
qemu.go
8
qemu.go
@@ -14,6 +14,14 @@
|
||||
// limitations under the License.
|
||||
*/
|
||||
|
||||
// Package qemu provides methods and types for launching and managing QEMU
|
||||
// instances. Instances can be launched with the LaunchQemu function and
|
||||
// managed thereafter via QMPStart and the QMP object that this function
|
||||
// returns. To manage a qemu instance after it has been launched you need
|
||||
// to pass the -qmp option during launch requesting the qemu instance to create
|
||||
// a QMP unix domain manageent socket, e.g.,
|
||||
// -qmp unix:/tmp/qmp-socket,server,nowait. For more information see the
|
||||
// example below.
|
||||
package qemu
|
||||
|
||||
import (
|
||||
|
||||
Reference in New Issue
Block a user