Repository navigation
[code-documentation] Document sandbox timeout options - #257
Merged
Pedro Henrique Penna (ppenna) merged 1 commit intoSep 29, 2026
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Pedro Henrique Penna (ppenna)
September 29, 2026 15:36
View session
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation accurately matches the sandbox parser defaults and managed lifecycle usage.
Review effort: Balanced
Findings: None
What changed in this PR
Documents existing sandbox timeout controls in the CLI reference.
Changes:
- Adds both timeout options to the sandbox synopsis.
- Documents their defaults, scope, and disabled behavior.
| File | Description |
|---|---|
doc/usage.md |
Documents managed control and guest workload timeouts. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pedro Henrique Penna (ppenna)
marked this pull request as ready for review
September 29, 2026 18:28
Pedro Henrique Penna (ppenna)
deleted the
code-documentation/sandbox-timeouts-36590525014-0a07dc84ddf48555
branch
September 29, 2026 18:51
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.
Summary
Documents the existing
sandboxtimeout controls in the command-line reference:--timeoutbounds managedstart,exec, andstopcontrol responses and defaults to 60 seconds.--exec-timeout-msbounds the managedexecguest workload and defaults to disabled (0).Evidence
The
doc/usage.mdsandbox section previously omitted both options from its synopsis and option table.scripts/nvx.pydefines both parser options and their defaults, then passes--timeoutto managedstart,exec, andstopand--exec-timeout-msto the managed guest workload.This is not a duplicate or rejected proposal: recent documentation PRs #242, #246, and #247 covered managed operation names, benchmark scratch storage, and workload identity respectively and were merged without maintainer objections. Open PR #110 changes only guest build/source sections in
doc/usage.md; open PRs #249 and #255 do not change documentation. Issue #229 tracks sandbox end-to-end testing rather than this command-reference omission.Scope
doc/usage.mdonly.python3 scripts/nvx.py sandbox --help.scripts/nvx.pyandscripts/test_nvx_tools.py.Validation
python3 scripts/nvx.py sandbox --help— passed; both options and defaults are present.python3 -m unittest scripts.test_nvx_tools.CliTests.test_sandbox_command_parses_state_aware_operations -v— passed (1 test).git diff --check— passed.git diff --numstat/git diff --raw— confirmed one documentation file, 4 changed lines, and no gitlink.No dependency, public API/CLI/ABI, gitlink, or OpenVMM change was made.