Skip to content

doc: list the environment bootstrap files in the source tree - #510

Merged
Pedro Henrique Penna (ppenna) merged 2 commits into
devfrom
doc-sync/bootstrap-source-tree
Oct 12, 2026
Merged

Pedro Henrique Penna (ppenna) merged 2 commits into
devfrom
doc-sync/bootstrap-source-tree

Conversation

@ppenna

Copy link
Copy Markdown
Contributor

Summary

Expand the previously collapsed scripts/setup/ entry in the
source-tree guide
so new contributors can find the platform-specific bootstrap scripts and their
shared tool-version manifest.

This deliberately fills one small gap in the tracked-layout map rather than
duplicating setup procedures or changing provisioning behavior. Only one
Markdown file changes: five added lines and one removed.

Comparison base: origin/dev at
9a2721a713a1bb78f0c94c189900cf89a728a26e.

Changes

Documented entry Evidence
Linux/MSHV development-host bootstrap scripts/setup/setup-linux-mshv.sh describes its existing-checkout Linux/MSHV role in its usage text.
Linux/KVM or Linux/MSHV Actions runner bootstrap scripts/setup/setup-linux-runner.sh names both backends and its runner registration options.
Windows/WHP development-host and Actions runner bootstrap scripts/setup/setup-windows-whp.ps1 enables WHP and distinguishes normal host setup from -RunnerOnly provisioning.
Shared tool release and checksum pins, now linked directly from the guide scripts/setup/tool-versions.conf contains the releases, artifact names, and SHA-256 pins read by the setup scripts.

git ls-files -- scripts\setup confirms that all four entries are tracked.
No version numbers or setup instructions are copied into the source-tree guide.
No design documents, implementation, CI definitions, performance data, or
OpenVMM gitlink changed.

Follow-ups

Relocate the
bootstrap guide
into doc/ in a later run. Its incoming links in
the setup guide
and the CI guide
overlap open PRs #405 and #406, so this run conservatively leaves those files
alone.

Validation

  • python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests:
    passed, 117 tests with one Windows skip (needs a Linux pseudo-terminal).
  • Throwaway script outside the repository: passed all 47 relative links and
    anchors in the changed guide, its incoming-link file (README.md), and the
    design index; confirmed one H1 and balanced code fences in the changed file,
    and links to all 16 chapters under doc/design/.
  • git diff --check: passed.
  • python scripts\nvx.py verify: passed before and after the documentation
    change. Checked-out OpenVMM matches the pinned
    2130f24b5a51561cc6224fe5a0aff93cb121ac32.
  • Full maintainer-style diff review: one coherent topic, Markdown-only paths,
    every added entry verified against source, and no files touched by open PRs.
  • git verify-commit HEAD: passed using the repository's signing configuration.
  • Branch pushed without force; upstream ahead/behind counts are 0/0.

No build or hypervisor runs are claimed or needed for this documentation-only
change.

Expand the setup directory in the source-tree guide so contributors can find the platform-specific host and Actions runner scripts and their shared tool release/checksum manifest. Link directly to the tracked manifest while leaving setup procedures in the setup guide.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 12, 2026 12:15
@ppenna Pedro Henrique Penna (ppenna) added the documentation Improvements or additions to documentation label Oct 12, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation is accurate; only a minor alignment nit remains.

1 open finding
What changed in this PR

Expands the repository guide to document environment bootstrap files.

Changes:

  • Lists platform-specific bootstrap scripts and the shared tool manifest.
  • Links directly to the tool manifest.
File Description
doc/​project-structure.md Documents bootstrap files and manifest.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread doc/project-structure.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 12, 2026 18:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation accurately matches the tracked setup files and their responsibilities.

0 open findings

1 resolved since last review

🧠 Review effort: Balanced

@ppenna
Pedro Henrique Penna (ppenna) merged commit 9d1ff76 into dev Oct 12, 2026
28 checks passed
@ppenna
Pedro Henrique Penna (ppenna) deleted the doc-sync/bootstrap-source-tree branch October 12, 2026 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants