Skip to content

[code-documentation] Document OpenVMM provenance command #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pedro Henrique Penna (ppenna) merged 3 commits into from
Oct 3, 2026
Merged

[code-documentation] Document OpenVMM provenance command #316

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c7ade0
Document OpenVMM provenance command
ppenna Oct 2, 2026
9aac77a
Update usage documentation for OpenVMM command
ppenna Oct 3, 2026
5d80d0d
Fix binary paths in usage documentation
ppenna Oct 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,20 @@ selection does not probe `/dev/kvm` or `/dev/mshv`, so compilation also works
on build-only hosts and hosts exposing both devices. Unsupported OS/backend
combinations are rejected.

### `record-openvmm-provenance`

```console
python3 scripts/nvx.py record-openvmm-provenance
```

Records the checked-out OpenVMM revision, clean-state flag, and executable
SHA-256 for the existing `openvmm/target/release/openvmm[.exe]` binary in
`build/openvmm.provenance.json`. The command takes no options. It requires
the OpenVMM submodule to be checked out/initialized and the release binary to
already exist at `openvmm/target/release/openvmm` on POSIX or
`openvmm/target/release/openvmm.exe` on Windows. The command fails if either
prerequisite is missing.

### `build`

```text
Expand Down
Loading