docs(cli): correct hew build -g Windows debug-info help text (#2235)#2645
Open
gertybotbot wants to merge 1 commit into
Open
docs(cli): correct hew build -g Windows debug-info help text (#2235)#2645gertybotbot wants to merge 1 commit into
hew build -g Windows debug-info help text (#2235)#2645gertybotbot wants to merge 1 commit into
Conversation
…ang#2235) The `-g`/`--debug` help still described Windows output as PE/COFF with embedded DWARF and cited hew-lang#2117 as an open follow-up, but hew-lang#2117 (merged as hew-lang#2230) added CodeView + a sidecar PDB for windows-msvc: the codegen path now sets the LLVM "CodeView" module flag on windows-msvc -g builds (hew-codegen-rs/src/llvm.rs) while windows-gnu keeps DWARF-in-PE. Update the help to state that windows-msvc emits COFF+CodeView+.pdb read natively by MSVC-toolchain debuggers, that windows-gnu still emits DWARF-in-PE, and to point the remaining-work reference at the open hew-lang#2235 follow-up rather than the closed hew-lang#2117. Docs-only; no behavioural change. hew-cli builds, cargo fmt --check and cargo clippy -p hew-cli -- -D warnings are clean; `hew build --help` renders the corrected text (hew-lang#2235 part c).
slepp
force-pushed
the
fix/2235c-build-g-help-text
branch
from
2fb29d7 to
15aa9ec
Compare
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
1 participant
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.
Part (c) of #2235 (CodeView/PDB follow-ups from #2117).
Problem
The
-g/--debughelp text onhew buildstill describes Windows debugoutput as PE/COFF with embedded DWARF and cites #2117 as an open follow-up.
That is stale: #2117 (merged as #2230) added CodeView + a sidecar PDB for
windows-msvc. The codegen path now sets the LLVM"CodeView"module flag onwindows-msvc-gbuilds (hew-codegen-rs/src/llvm.rs:40559, gatedWindows-MSVC-only), so MSVC-toolchain debuggers read those builds natively;
only
windows-gnustill emits DWARF-in-PE.Change
Docs-only edit to the
BuildArgs::debugdoc-comment inhew-cli/src/args.rs:windows-msvc→ COFF + CodeView + sidecar.pdb, read natively byMSVC-toolchain debuggers (and lldb-on-Windows), noting Windows
-gdebuggability: emit CodeView/PDB for Windows-native debuggers #2117 is now closed.windows-gnu→ still PE/COFF with embedded DWARF (unchanged behaviour).instead of the now-closed Windows
-gdebuggability: emit CodeView/PDB for Windows-native debuggers #2117.No behavioural change; this only corrects user-facing
--helptext.Scope note: parts (a) (CodeView e2e CI test) and (b) (
needs_pdb_debugpredicate alignment) of #2235 are separate, non-docs work and are not
touched here.
Verification (Linux)
cargo build -p hew-cli— cleancargo fmt -p hew-cli -- --check— cleancargo clippy -p hew-cli -- -D warnings— cleanhew build --helprenders the corrected text