Update and create documentation in build.cmd and build.sh for CoreCLR test builds#126951
Update and create documentation in build.cmd and build.sh for CoreCLR test builds#126951
Conversation
…ommand sync Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/0ff1f33d-17b4-43db-aa5f-b488e6f5f1a5 Co-authored-by: davidwrighton <10779849+davidwrighton@users.noreply.github.com>
davidwrighton
left a comment
There was a problem hiding this comment.
Add test build script docs for os specification.
There was a problem hiding this comment.
Pull request overview
Updates the user-facing help text in the CoreCLR test build scripts to better document supported options (especially OS targeting, WASM architecture, and CoreCLR-vs-Mono selection), and fixes a few shell-usage formatting issues.
Changes:
- Documented OS targeting options in
src/tests/build.cmdandsrc/tests/build.sh(including browser/WASI shorthands on Windows, and-osvia the common framework on Unix). - Added missing
-CoreCLR/-coreclrhelp entries (option already existed in argument parsing). - Corrected path/escaping examples in
build.shthat were copied from the Windows batch script.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/tests/build.sh | Adds OS-targeting and -coreclr help text; fixes path/escaping in usage examples. |
| src/tests/build.cmd | Expands usage docs to include wasm, OS targeting options, and -CoreCLR. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
🤖 Copilot Code Review — PR #126951Note This review was generated by GitHub Copilot using multi-model analysis (Claude Opus 4.6 primary, Claude Sonnet 4 and GPT-5.3-Codex sub-agents). Holistic AssessmentMotivation: The PR documents already-implemented but undocumented options ( Approach: Documentation-only changes to help text strings. The approach is appropriate and low-risk. Summary: Detailed Findings✅ Correctness — All documented options verified against implementationAll newly documented options match the actual parsing code:
Flagged by: all 3 models ✅ Shell syntax fix — Correct removal of Windows artifacts from bash scriptThe three
All three issues are correctly fixed. The semicolon fix was addressed in the second commit after a prior review flagged it. Flagged by: all 3 models
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| echo browser: Shorthand for "os browser" ^(targets WebAssembly in the browser^). | ||
| echo wasi: Shorthand for "os wasi" ^(targets WebAssembly System Interface^). |
There was a problem hiding this comment.
The new OS targeting help for browser/wasi reads like those options alone “target WebAssembly”, but this script’s default architecture is still x64 unless the user also passes wasm. Consider clarifying in the help text that browser/wasi typically need to be combined with the wasm architecture (e.g., wasm browser / wasm wasi) to actually build the WebAssembly target.
| echo browser: Shorthand for "os browser" ^(targets WebAssembly in the browser^). | |
| echo wasi: Shorthand for "os wasi" ^(targets WebAssembly System Interface^). | |
| echo browser: Shorthand for "os browser" ^(typically combine with "wasm", for example "wasm browser"^). | |
| echo wasi: Shorthand for "os wasi" ^(typically combine with "wasm", for example "wasm wasi"^). |
Summary
Updates the help text/documentation in
src/tests/build.cmdandsrc/tests/build.shfor the CoreCLR test build scripts.Changes
src/tests/build.cmdwasmto the list of valid build architectures in the usage sectionos <value>,browser(shorthand foros browser), andwasi(shorthand foros wasi) options-CoreCLRto the usage section (the option was implemented in the code but missing from the help text)src/tests/build.shusage_listdocumenting the-os <value>option (handled by the common build framework), listing common OS values, and noting that native test components are automatically skipped for mobile/device targets (android,ios,iossimulator,tvos,tvossimulator)-coreclrtousage_list(the option was implemented in the code but missing from the help text)^(,^)) and Windows-style backslashes in path examples that were incorrectly copied from the Windows batch scriptCommand sync check
os <value>,browser,wasi-os <value>(via common framework)x64,x86,arm64,wasm-CoreCLR/-coreclr-Mono/-ExcludeMonoFailures-mono_aot,-mono_fullaot-runtestsrun.cmd)-MSBuild-ninja falsevia common framework-PDBNote
This PR was generated by GitHub Copilot.