Skip to content

Remove DEMANGLE_SUPPORT from docs (NFC) #21430

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 26, 2024
Merged

Remove DEMANGLE_SUPPORT from docs (NFC) #21430

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cb1cde
Remove DEMANGLE_SUPPORT from docs (deprecated as of Emscripten 3.1.54)
cwoffenden Feb 26, 2024
93e8352
Removed both alternate JS calls
cwoffenden Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions site/source/docs/porting/Debugging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,6 @@ Some important settings are:
performance. Default value is 1 if ``ASSERTIONS=1`` is set, and disabled
otherwise.

-
.. _debugging-DEMANGLE_SUPPORT:

``DEMANGLE_SUPPORT=1`` links in code to automatically demangle stack traces, that is, emit human-readable C++ function names instead of ``_ZN..`` ones.

A number of other useful debug settings are defined in `src/settings.js <https://github.com/emscripten-core/emscripten/blob/main/src/settings.js>`_. For more information, search that file for the keywords "check" and "debug".

.. _debugging-sanitizers:
Expand All @@ -166,7 +161,7 @@ Manual print debugging

You can also manually instrument the source code with ``printf()`` statements, then compile and run the code to investigate issues. Note that ``printf()`` is line-buffered, make sure to add ``\n`` to see output in the console.

If you have a good idea of the problem line you can add ``print(new Error().stack)`` to the JavaScript to get a stack trace at that point. Also available is :js:func:`stackTrace`, which emits a stack trace and also tries to demangle C++ function names if ``DEMANGLE_SUPPORT`` is enabled (if you don't want or need C++ demangling in a specific stack trace, you can call :js:func:`jsStackTrace`).
If you have a good idea of the problem line you can add ``print(new Error().stack)`` to the JavaScript to get a stack trace at that point. Also available is :js:func:`stackTrace`, which emits stack trace with any extra details available (alternatively call :js:func:`jsStackTrace` to get just the stack trace).

Debug printouts can even execute arbitrary JavaScript. For example::

Expand Down