Add .github/copilot-instructions.md for Copilot context#64
Open
benhillis wants to merge 1 commit into
Open
Conversation
Document the Docker-based build system architecture, build commands, and key conventions (package structure, kernel config workflow, component governance) to help future Copilot sessions work effectively in this repository. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
smalis-msft
reviewed
May 20, 2026
| --output type=local,dest=out/linux-6.1 . | ||
|
|
||
| # Cross-compilation requires qemu-user-static | ||
| apt install qemu-user-static |
Contributor
There was a problem hiding this comment.
Installing after running the build commands isn't gonna help much haha
There was a problem hiding this comment.
Pull request overview
Adds a repository-specific .github/copilot-instructions.md to provide GitHub Copilot with context about how openvmm-deps is structured and how to build it (Docker multi-stage build, sysroots/packages, kernel workflow, and cgmanifest checks).
Changes:
- Introduces a Copilot instructions document covering architecture and key build scripts.
- Documents common Docker build commands and the cgmanifest sync check.
- Captures conventions for sysroots/packages and the kernel-version/config workflow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+32
to
+41
| | Target | Purpose | | ||
| |--------|---------| | ||
| | `result-sdk` | Static libs (openssl, symcrypt, libunwind) for linking openvmm | | ||
| | `result-dbgrd` | Full debug rootfs (gdb, strace, htop) | | ||
| | `result-shell` | Minimal busybox shell rootfs | | ||
| | `result-initrd` | Shared test initrd for Linux-direct boot | | ||
| | `result-petritools` | Performance tools rootfs (fio, iperf3) as EROFS | | ||
| | `result-linux-6.1` | Linux 6.1 LTS kernel images | | ||
| | `result-linux-6.18` | Linux 6.18 kernel images | | ||
|
|
Comment on lines
+46
to
+50
| docker build --platform x86_64 --output type=local,dest=out . | ||
| docker build --platform aarch64 --output type=local,dest=out . | ||
|
|
||
| # Single target (faster iteration) | ||
| docker build --platform x86_64 --target result-linux-6.1 \ |
Comment on lines
+79
to
+80
| - Never edit configs outside the container — always extract the post- | ||
| `olddefconfig` result from the build output (see `pkg/linux/README.md`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a copilot-instructions.md file documenting:
This helps future Copilot sessions understand the repo structure and work effectively without needing to explore from scratch each time.