microsoft/openvmm
Publicmirrored fromhttps://github.com/microsoft/openvmmAvailable
Guide/src/SUMMARY.md
128lines · 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 | - [Cross Compiling for Windows](./dev_guide/getting_started/cross_compile.md) |
| 30 | - [Testing](./dev_guide/tests.md) |
| 31 | - [Unit Tests](./dev_guide/tests/unit.md) |
| 32 | - [VMM Tests](./dev_guide/tests/vmm.md) |
| 33 | - [Azure-hosted Test Images](./dev_guide/tests/vmm/azure_images.md) |
| 34 | - [Fuzzing](./dev_guide/tests/fuzzing.md) |
| 35 | - [Running Fuzzers](./dev_guide/tests/fuzzing/running.md) |
| 36 | - [Writing Fuzzers](./dev_guide/tests/fuzzing/writing.md) |
| 37 | - [Developer Tools / Utilities](./dev_guide/dev_tools.md) |
| 38 | - [`flowey`](./dev_guide/dev_tools/flowey.md) |
| 39 | - [`Flowey Fundamentals`](./dev_guide/dev_tools/flowey/flowey_fundamentals.md) |
| 40 | - [`Steps`](./dev_guide/dev_tools/flowey/steps.md) |
| 41 | - [`Variables`](./dev_guide/dev_tools/flowey/variables.md) |
| 42 | - [`Nodes`](./dev_guide/dev_tools/flowey/nodes.md) |
| 43 | - [`Artifacts`](./dev_guide/dev_tools/flowey/artifacts.md) |
| 44 | - [`Pipelines`](./dev_guide/dev_tools/flowey/pipelines.md) |
| 45 | - [`Nix`](./dev_guide/dev_tools/flowey/nix.md) |
| 46 | - [`cargo xtask`](./dev_guide/dev_tools/xtask.md) |
| 47 | - [`cargo xflowey`](./dev_guide/dev_tools/xflowey.md) |
| 48 | - [VmgsTool](./dev_guide/dev_tools/vmgstool.md) |
| 49 | - [update-rootfs.py]() |
| 50 | - [igvmfilegen]() |
| 51 | - [guest_test_uefi](./dev_guide/dev_tools/guest_test_uefi.md) |
| 52 | - [hypestv](./dev_guide/dev_tools/hypestv.md) |
| 53 | - [Contributing](./dev_guide/contrib.md) |
| 54 | - [Coding Conventions](./dev_guide/contrib/code.md) |
| 55 | - [Save State](./dev_guide/contrib/save-state.md) |
| 56 | - [Releases & Code Flow](./dev_guide/contrib/release.md) |
| 57 | - [Submitting Changes](./dev_guide/contrib/pr.md) |
| 58 | - [Code Review Process](./dev_guide/contrib/code_review.md) |
| 59 | - [Guide Updates](./dev_guide/contrib/guide.md) |
| 60 | |
| 61 | # Reference |
| 62 | |
| 63 | - [OpenVMM Features](./reference/openvmm.md) |
| 64 | - [Configuration and Management](./reference/openvmm/management.md) |
| 65 | - [CLI](./reference/openvmm/management/cli.md) |
| 66 | - [Interactive Console](./reference/openvmm/management/interactive_console.md) |
| 67 | - [gRPC / ttrpc](./reference/openvmm/management/grpc.md) |
| 68 | - [Graphical Console](./reference/openvmm/graphical_console.md) |
| 69 | - [Logging](./reference/openvmm/logging.md) |
| 70 | - [OpenHCL Features](./reference/openhcl.md) |
| 71 | - [Dynamic Configuration]() |
| 72 | - [Diagnostics](./reference/openhcl/diag.md) |
| 73 | - [Preface: CVM restrictions](./reference/openhcl/diag/cvm_restrictions.md) |
| 74 | - [Intro to ohcldiag-dev](./reference/openhcl/diag/ohcldiag_dev.md) |
| 75 | - [Network packet capture (PCAP)](./reference/openhcl/diag/ohcldiag_dev/pcap.md) |
| 76 | - [Performance analysis](./reference/openhcl/diag/ohcldiag_dev/perf.md) |
| 77 | - [Tracing](./reference/openhcl/diag/tracing.md) |
| 78 | - [Developer Features]() |
| 79 | - [Hardware Debugging (gdbstub)](./reference/dev_feats/gdbstub.md) |
| 80 | - [Kernel Debugging (KDNET)](./reference/dev_feats/kdnet.md) |
| 81 | - [Devices]() |
| 82 | - [Firmware]() |
| 83 | - [UEFI: mu_msvm](./reference/devices/firmware/mu_msvm_uefi.md) |
| 84 | - [BIOS: Hyper-V PCAT BIOS](./reference/devices/firmware/pcat_bios.md) |
| 85 | - [Linux Direct]() |
| 86 | - [Virtio]() |
| 87 | - [virtio-fs]() |
| 88 | - [virtio-9p]() |
| 89 | - [virtio-net]() |
| 90 | - [virtio-pmem]() |
| 91 | - [VMBus]() |
| 92 | - [storvsp]() |
| 93 | - [netvsp]() |
| 94 | - [vpci]() |
| 95 | - [serial]() |
| 96 | - [framebuffer]() |
| 97 | - [input]() |
| 98 | - [Emulated]() |
| 99 | - [vTPM]() |
| 100 | - [NVMe]() |
| 101 | - [Overview](./reference/emulated/NVMe/overview.md) |
| 102 | - [Doorbells](./reference/emulated/NVMe/doorbells.md) |
| 103 | - [Serial]() |
| 104 | - [Legacy x86]() |
| 105 | - [i440BX + PIIX4 chipset]() |
| 106 | - [IDE HDD/Optical]() |
| 107 | - [Floppy]() |
| 108 | - [PCI]() |
| 109 | - [VGA]() |
| 110 | - [Direct Assigned]() |
| 111 | - [Device Backends]() |
| 112 | - [Serial]() |
| 113 | - [Graphics and Input]() |
| 114 | - [Storage]() |
| 115 | - [Networking]() |
| 116 | - [Architecture](./reference/architecture.md) |
| 117 | - [OpenVMM Architecture](./reference/architecture/openvmm.md) |
| 118 | - [mesh]() |
| 119 | - [inspect]() |
| 120 | - [OpenHCL Architecture](./reference/architecture/openhcl.md) |
| 121 | - [Processes and Components](./reference/architecture/openhcl/processes.md) |
| 122 | - [Boot Flow](./reference/architecture/openhcl/boot.md) |
| 123 | - [Sidecar](./reference/architecture/openhcl/sidecar.md) |
| 124 | - [IGVM](./reference/architecture/openhcl/igvm.md) |
| 125 | |
| 126 | --- |
| 127 | |
| 128 | [OpenVMM Rust Crate API Docs](./rustdoc.md) |
| 129 | |