docs: add GDB stub and source-level debugging to reproducing-runs tutorial#315
Merged
Wenzel merged 2 commits intointel:mainfrom Mar 29, 2026
Merged
docs: add GDB stub and source-level debugging to reproducing-runs tutorial#315Wenzel merged 2 commits intointel:mainfrom
Wenzel merged 2 commits intointel:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the EDK2 UEFI “Reproducing Runs” tutorial to document attaching a GDB remote stub and performing source-level debugging, and adjusts the tutorial build script to copy EDK2 sources locally to support symbol/source mapping.
Changes:
- Copy
/edk2sources out of the Docker build container to enable source-level debugging workflows. - Expand the reproducing-runs tutorial with sections on GDB stub usage and loading symbols/source paths.
- Add a cross-link from the “Disable Auto-Continue in Repro Mode” config option to the new GDB-stub walkthrough.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| examples/tutorials/edk2-uefi/build.sh | Copies EDK2 sources from the container to the host for GDB source mapping. |
| docs/src/tutorials/edk2-uefi/reproducing-runs.md | Adds detailed GDB-stub + source-level debugging walkthrough to the repro tutorial. |
| docs/src/config/common-options.md | Links config option docs to the new tutorial walkthrough section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…orial Restructures the reproducing-runs page into three sections: testcase listing, SIMICS reverse debugging, and live GDB stub debugging. Adds a new source-level debugging section covering OS awareness setup, module load address discovery, .text RVA extraction, symbol loading with add-symbol-file, and source path mapping with set substitute-path. Updates build.sh to copy edk2 sources from the Docker container for use with GDB set substitute-path, with a rm -rf guard against the docker cp stale directory bug. Updates common-options.md repro_auto_continue entry to link forward to the new GDB stub walkthrough.
Wenzel
force-pushed
the
docs/gdb-stub-debugging
branch
from
59aa728 to
d2d4964
Compare
Fix MD013 line length, MD048 code fence style, MD040 missing language tags, and MD010 hard tabs in reproducing-runs.md. Link "repro functionality" to analyzing-results.md instead of the auto-continue option. Gate edk2 source copy on COPY_SOURCES=1 env var to avoid large generated directories on every build. Add edk2/ to .gitignore.
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.
No description provided.