Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the Debugging docs #14052

Closed
wants to merge 8 commits into from
Closed

Update the Debugging docs #14052

wants to merge 8 commits into from

Conversation

pfaffe
Copy link
Collaborator

@pfaffe pfaffe commented Apr 29, 2021

Add some details for -gseparate-dwarf and -gsplit-dwarf.

@pfaffe pfaffe requested a review from kripken April 29, 2021 10:20
site/source/docs/porting/Debugging.rst Outdated Show resolved Hide resolved
site/source/docs/porting/Debugging.rst Outdated Show resolved Hide resolved
site/source/docs/porting/Debugging.rst Outdated Show resolved Hide resolved
site/source/docs/porting/Debugging.rst Outdated Show resolved Hide resolved
@RReverser
Copy link
Collaborator

@pfaffe Did you see the CI failures on the PR? Some cross-refs look invalid.

@kripken
Copy link
Member

kripken commented Jun 16, 2021

Anything I can help with here? These docs would be useful, as we get questions about this topic, see e.g. #12195 (comment)

@kripken
Copy link
Member

kripken commented Jun 17, 2021

The docs error is that emcc.txt is not updated. To fix that run make text and copy emcc.txt to /docs/emcc.txt.

Also merging in latest main will fix the other issues.

@stale
Copy link

stale bot commented Jul 10, 2022

This issue has been automatically marked as stale because there has been no activity in the past year. It will be closed automatically if no further activity occurs in the next 30 days. Feel free to re-open at any time if this issue is still relevant.

@stale stale bot added the wontfix label Jul 10, 2022
@connorjclark
Copy link
Contributor

connorjclark commented Oct 13, 2023

Happy I found this PR! Can we land the doc updates please?

The docs error is that emcc.txt is not updated. To fix that run make text and copy emcc.txt to /docs/emcc.txt.

I could handle this, assuming the content of this PR is still accurate.

relevant: #17814

@stale stale bot removed the wontfix label Oct 13, 2023
detailed debugging experience and is supported as an experiment in Chrome 88
with an `extension <https://goo.gle/wasm-debugging-extension>`. See
`here <https://developer.chrome.com/blog/wasm-debugging-2020/>` for a detailed
usage guide. Source maps are more widely supported in Firefox, Chrome, and
Copy link
Contributor

Choose a reason for hiding this comment

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

@pfaffe
Copy link
Collaborator Author

pfaffe commented Oct 16, 2023

Yes the content is still accurate. Please feel free to take care of landing the PR if you're interested!

``llvm-dwp`` tool then, but that could happen in parallel to the linking of
the compiled output! A compatible version should be part of your emscripten
distribution, for example in ``$EMSDK/upstream/bin/llvm-dwp``. When running it
after linking, it's as simple as ``llvm-dwp -e foo.wasm -o foo.wasm.dwp``, or
Copy link
Contributor

Choose a reason for hiding this comment

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

should this be emdwp instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah yes, nice catch! emdwp eliminates having to look up the path in upstream/bin as well!

@connorjclark connorjclark mentioned this pull request Oct 16, 2023
Copy link
Collaborator

@sbc100 sbc100 left a comment

Choose a reason for hiding this comment

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

Thanks for keeping the docs up-to-date!


``-gsplit-dwarf``
Enable debug fission, which creates split DWARF object files alongside the
wasm object files. This option must be used together with ``-c``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this true? -gsplit-dwarf only makes sense when compiling and not when linking?

@RReverser
Copy link
Collaborator

@sbc100 IIUC, I think this PR can be closed as it was finished & landed in #20463.

@pfaffe
Copy link
Collaborator Author

pfaffe commented Nov 6, 2023

Yup this is obsolete now, closing! Thanks for landing, Connor!

@pfaffe pfaffe closed this Nov 6, 2023
@pfaffe pfaffe deleted the debugging_docs branch November 6, 2023 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants