microsoft/openvmm

Public

mirrored fromhttps://github.com/microsoft/openvmmAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
3a2b5b0653c6ffe70127f53fc89317957e9d498e

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

Guide/src/SUMMARY.md

112lines · modecode

1# Summary
2
3[Introduction](./index.md)
4
5# Getting Started
6
7- [OpenVMM](./user_guide/openvmm.md)
8 - [Running OpenVMM](./user_guide/openvmm/run.md)
9 - [Troubleshooting](./user_guide/openvmm/troubleshooting.md)
10 - [Next Steps](./user_guide/openvmm/next_steps.md)
11- [OpenHCL](./user_guide/openhcl.md)
12 - [Running OpenHCL](./user_guide/openhcl/run.md)
13 - [On Windows - Hyper-V](./user_guide/openhcl/run/hyperv.md)
14 - [On Windows - OpenVMM](./user_guide/openhcl/run/openvmm.md)
15 - [On Linux](./user_guide/openhcl/run/openvmm_linux.md)
16 - [Troubleshooting](./user_guide/openhcl/troubleshooting.md)
17 - [Next Steps](./user_guide/openhcl/next_steps.md)
18
19# Developer Guide
20
21- [Getting Started](./dev_guide/getting_started.md)
22 - [On Linux / WSL2](./dev_guide/getting_started/linux.md)
23 - [On Windows](./dev_guide/getting_started/windows.md)
24 - [Via Codespaces / Dev Container](./dev_guide/getting_started/devcontainer.md)
25 - [Building OpenVMM](./dev_guide/getting_started/build_openvmm.md)
26 - [Building OpenHCL](./dev_guide/getting_started/build_openhcl.md)
27 - [Building a Custom Kernel](./dev_guide/getting_started/build_ohcl_kernel.md)
28 - [Suggested Dev Environment](./dev_guide/getting_started/suggested_dev_env.md)
29- [Testing](./dev_guide/tests.md)
30 - [Unit Tests](./dev_guide/tests/unit.md)
31 - [VMM Tests](./dev_guide/tests/vmm.md)
32 - [Azure-hosted Test Images](./dev_guide/tests/vmm/azure_images.md)
33 - [Fuzzing](./dev_guide/tests/fuzzing.md)
34 - [Running Fuzzers](./dev_guide/tests/fuzzing/running.md)
35 - [Writing Fuzzers](./dev_guide/tests/fuzzing/writing.md)
36- [Developer Tools / Utilities](./dev_guide/dev_tools.md)
37 - [`cargo xtask`](./dev_guide/dev_tools/xtask.md)
38 - [`cargo xflowey`](./dev_guide/dev_tools/xflowey.md)
39 - [VmgsTool](./dev_guide/dev_tools/vmgstool.md)
40 - [update-rootfs.py]()
41 - [igvmfilegen]()
42 - [guest_test_uefi](./dev_guide/dev_tools/guest_test_uefi.md)
43 - [hypestv](./dev_guide/dev_tools/hypestv.md)
44- [Contributing](./dev_guide/contrib.md)
45 - [Coding Conventions](./dev_guide/contrib/code.md)
46 - [Releases & Code Flow](./dev_guide/contrib/release.md)
47 - [Submitting Changes](./dev_guide/contrib/pr.md)
48 - [Guide Updates](./dev_guide/contrib/guide.md)
49
50# Reference
51
52- [OpenVMM Features](./reference/openvmm.md)
53 - [Configuration and Management](./reference/openvmm/management.md)
54 - [CLI](./reference/openvmm/management/cli.md)
55 - [Interactive Console](./reference/openvmm/management/interactive_console.md)
56 - [gRPC / ttrpc](./reference/openvmm/management/grpc.md)
57 - [Graphical Console](./reference/openvmm/graphical_console.md)
58 - [Logging](./reference/openvmm/logging.md)
59- [OpenHCL Features](./reference/openhcl.md)
60 - [Dynamic Configuration]()
61 - [Diagnostics](./reference/openhcl/diag.md)
62 - [Preface: CVM restrictions](./reference/openhcl/diag/cvm_restrictions.md)
63 - [Intro to ohcldiag-dev](./reference/openhcl/diag/ohcldiag_dev.md)
64 - [Network packet capture (PCAP)](./reference/openhcl/diag/ohcldiag_dev/pcap.md)
65 - [Performance analysis](./reference/openhcl/diag/ohcldiag_dev/perf.md)
66 - [Tracing](./reference/openhcl/diag/tracing.md)
67- [Developer Features]()
68 - [Hardware Debugging (gdbstub)](./reference/dev_feats/gdbstub.md)
69 - [Kernel Debugging (KDNET)](./reference/dev_feats/kdnet.md)
70- [Devices]()
71 - [Firmware]()
72 - [UEFI: mu_msvm](./reference/devices/firmware/mu_msvm_uefi.md)
73 - [BIOS: Hyper-V PCAT BIOS](./reference/devices/firmware/pcat_bios.md)
74 - [Linux Direct]()
75 - [Virtio]()
76 - [virtio-fs]()
77 - [virtio-9p]()
78 - [virtio-serial]()
79 - [virtio-net]()
80 - [virtio-pmem]()
81 - [VMBus]()
82 - [storvsp]()
83 - [netvsp]()
84 - [vpci]()
85 - [serial]()
86 - [framebuffer]()
87 - [input]()
88 - [Emulated]()
89 - [vTPM]()
90 - [NVMe]()
91 - [Serial]()
92 - [Legacy x86]()
93 - [i440BX + PIIX4 chipset]()
94 - [IDE HDD/Optical]()
95 - [Floppy]()
96 - [PCI]()
97 - [VGA]()
98 - [Direct Assigned]()
99- [Device Backends]()
100 - [Serial]()
101 - [Graphics and Input]()
102 - [Storage]()
103 - [Networking]()
104- [Architecture](./reference/architecture.md)
105 - [OpenVMM Architecture](./reference/architecture/openvmm.md)
106 - [mesh]()
107 - [inspect]()
108 - [OpenHCL Architecture](./reference/architecture/openhcl.md)
109
110---
111
112[OpenVMM Rust Crate API Docs](./rustdoc.md)
113