Skip to content

[docs] Update emscripten_get_compiler_setting documentation #27482

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
sbc100 merged 1 commit into from
Aug 4, 2026
+4 −5
Merged

[docs] Update emscripten_get_compiler_setting documentation #27482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions site/source/docs/api_reference/emscripten.h.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1343,9 +1343,8 @@ Functions
For values containing anything other than an integer, a string is returned
(you will need to cast the ``long`` return value to a ``char*``).

Some useful things this can do is provide the version of Emscripten
(“EMSCRIPTEN_VERSION”), the optimization level (“OPT_LEVEL”), debug level
(“DEBUG_LEVEL”), etc.
In addition to normal compiler settings (such as ``INITIAL_MEMORY`` or
``ASSERTIONS``), ``EMSCRIPTEN_VERSION`` can also be retrieved as a string.

For this command to work, you must build with the following compiler option
(as we do not want to increase the build size with this metadata): ::
Expand All @@ -1354,8 +1353,8 @@ Functions

:param name: The compiler setting to return.
:type name: const char*
:returns: The value of the specified setting. Note that for values other than an integer, a string is returned (cast the ``int`` return value to a ``char*``).
:rtype: int
:returns: The value of the specified setting. Note that for values other than an integer, a string is returned (cast the ``long`` return value to a ``char*``).
:rtype: long

.. c:function:: int emscripten_has_asyncify()

Expand Down
Loading