CINXE.COM
Bug Reporting — Emscripten 4.0.0-git (dev) documentation
<!DOCTYPE html> <html class="writer-html5" lang="en"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Bug Reporting — Emscripten 4.0.0-git (dev) documentation</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" /> <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=6895f958" /> <link rel="shortcut icon" href="../../_static/emscripten.ico"/> <script src="../../_static/jquery.js?v=5d32c60e"></script> <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=faf469f6"></script> <script src="../../_static/doctools.js?v=888ff710"></script> <script src="../../_static/sphinx_highlight.js?v=4825356b"></script> <script src="../../_static/js/theme.js"></script> <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="FAQ" href="FAQ.html" /> <link rel="prev" title="Emscripten Test Suite" href="test-suite.html" /> </head> <body class="wy-body-for-nav"> <div class="grid-to-center-rtd-theme"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="../../index.html"> <!-- <img src="../..//_static/" alt="Logo"> --> <img src="../../_static/Emscripten_logo_full.png" class="logo" alt="Logo"/> </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../introducing_emscripten/index.html">Introducing Emscripten</a></li> <li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="downloads.html">Download and install</a></li> <li class="toctree-l2"><a class="reference internal" href="Tutorial.html">Emscripten Tutorial</a></li> <li class="toctree-l2"><a class="reference internal" href="test-suite.html">Emscripten Test Suite</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Bug Reporting</a><ul> <li class="toctree-l3"><a class="reference internal" href="#llvm-wasm-ld-clang-binaryen-bugs">LLVM, wasm-ld, clang, Binaryen bugs</a></li> <li class="toctree-l3"><a class="reference internal" href="#site-and-documentation-bugs">Site and documentation bugs</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="FAQ.html">FAQ</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../compiling/index.html">Compiling and Running Projects</a></li> <li class="toctree-l1"><a class="reference internal" href="../porting/index.html">Porting</a></li> <li class="toctree-l1"><a class="reference internal" href="../api_reference/index.html">API Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools_reference/index.html">Tools Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="../optimizing/Optimizing-Code.html">Optimizing Code</a></li> <li class="toctree-l1"><a class="reference internal" href="../optimizing/Optimizing-WebGL.html">Optimizing WebGL</a></li> <li class="toctree-l1"><a class="reference internal" href="../debugging/Sanitizers.html">Debugging with Sanitizers</a></li> <li class="toctree-l1"><a class="reference internal" href="../building_from_source/index.html">Building Emscripten from Source</a></li> <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to Emscripten</a></li> <li class="toctree-l1"><a class="reference internal" href="../optimizing/Profiling-Toolchain.html">Profiling the Toolchain</a></li> <li class="toctree-l1"><a class="reference internal" href="../site/about.html">About this site</a></li> <li class="toctree-l1"><a class="reference internal" href="../../genindex.html">Index</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <!-- <a href="../../index.html">Emscripten</a> --> <a href="../../index.html"> <img src="../../_static/Emscripten_logo_full.png" alt="Logo" /> </a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <!--begin hamishw addition --> <!--Nav bar defined as a document followed by short version of nav text and long version If no such page exists then nav item is not created. CSS defines which of the long or short version is displayed. --> <a href="https://github.com/emscripten-core/emscripten"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" data-canonical-src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png"></a> <div class="main-nav-bar" style=""> <!-- the layout of the menu options - centered with left and right alignment of the first and last loop items respectively. This is VERY UGLY as I'm adding to the CSS in the code to force the alignment. Would be better just to have the elements here and have the CSS in the CSS file. This could be done with a CSS selector, but not worked out how yet. --> <ul id="menu-options"> <li style="text-align:left;"><a class="navlink-short" title="Docs" href="../index.html">Docs</a><a class="navlink-long" title="Documentation" href="../index.html">Documentation</a></li> <li><a class="navlink-short" title="SDK" href="downloads.html">SDK</a><a class="navlink-long" title="Downloads" href="downloads.html">Downloads</a></li> <li><a class="navlink-short" title="Help" href="../introducing_emscripten/community.html">Help</a><a class="navlink-long" title="Community" href="../introducing_emscripten/community.html">Community</a></li> <li style="text-align:right;"><a class="navlink-short" title="GitHub" href="../index.html">GitHub</a><a class="navlink-long" title="" href="../index.html"></a></li> </ul> <!-- <div style="clear:both;"></div> --> <div role="navigation" aria-label="breadcrumbs navigation"> <div class="breadcrumb-box"> <a class="breadcrumb-box-item" href="../../index.html">Home</a> <a class="breadcrumb-box-item" href="index.html">» Getting Started</a> <div class="breadcrumb-box-item">» Bug Reporting</div> </div> </div> </div> <!--end hamishw addition --> <!--HamishW move <div role="navigation" aria-label="breadcrumbs navigation"> <div class="breadcrumb-box"> <a class="breadcrumb-box-item" href="../../index.html">Home</a> <a class="breadcrumb-box-item" href="index.html">» Getting Started</a> <div class="breadcrumb-box-item">» Bug Reporting</div> </div> </div> --> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="bug-reporting"> <span id="bug-reports"></span><h1>Bug Reporting<a class="headerlink" href="#bug-reporting" title="Permalink to this heading"></a></h1> <p>All bugs should be filed in the GitHub <a class="reference external" href="https://github.com/emscripten-core/emscripten">main</a> Emscripten repository <a class="reference external" href="https://github.com/emscripten-core/emscripten/issues?state=open">Issue Tracker</a>.</p> <p>Please supply as much relevant information as possible, including:</p> <ul class="simple"> <li><p>Original source code.</p></li> <li><p>Generated bitcode (<strong>.bc</strong>, <strong>.o</strong> or <strong>.ll</strong>)</p></li> <li><p>Environment information — including <em>emcc</em> and <em>clang</em> versions (as reported by <code class="docutils literal notranslate"><span class="pre">emcc</span> <span class="pre">-v</span></code>).</p></li> <li><p>Error symptoms.</p></li> <li><p>Proposed solutions, ideally with a pull request.</p></li> </ul> <div class="admonition tip"> <p class="admonition-title">Tip</p> <p>Compile with <code class="docutils literal notranslate"><span class="pre">EMCC_DEBUG=1</span></code> and grab the <strong>/tmp/emscripten_temp/emcc-*</strong> files (these include the bitcode and JavaScript in several stages). Note that the <strong>emscripten_temp</strong> directory should be emptied manually first, so it only contains new content!</p> </div> <section id="llvm-wasm-ld-clang-binaryen-bugs"> <h2>LLVM, wasm-ld, clang, Binaryen bugs<a class="headerlink" href="#llvm-wasm-ld-clang-binaryen-bugs" title="Permalink to this heading"></a></h2> <p>If uncertain, bugs can always be posted to the <a class="reference external" href="https://github.com/emscripten-core/emscripten">main repository</a>. But if you are sure a bug is in an upstream project, you can file it there:</p> <ul class="simple"> <li><p><a class="reference external" href="https://bugs.llvm.org/">LLVM bug tracker</a> . For most issues use the “libraries” product and the “Backend: WebAssembly” component. For wasm-ld issues, use “lld” and “wasm”.</p></li> <li><p><a class="reference external" href="https://github.com/WebAssembly/binaryen/issues">Binaryen bug tracker</a></p></li> </ul> <p>Pull requests must (of course) go to the proper repository.</p> </section> <section id="site-and-documentation-bugs"> <span id="site-and-documentation-bug-reports"></span><h2>Site and documentation bugs<a class="headerlink" href="#site-and-documentation-bugs" title="Permalink to this heading"></a></h2> <p>Documentation (site) bugs should be filed in the same <a class="reference external" href="https://github.com/emscripten-core/emscripten/issues?state=open">Issue Tracker</a>.</p> <p>Include relevant information including:</p> <ul class="simple"> <li><p>The URL and title of the affected page(s).</p></li> <li><p>A description of the problem.</p></li> <li><p>Suggestions for a possible solution.</p></li> </ul> <div class="admonition tip"> <p class="admonition-title">Tip</p> <p>The <a class="reference external" href="https://github.com/emscripten-core/emscripten/issues/new?title=Bug%20in%20page:How%20to%20Report%20Bugs%20%28under-construction%29%20&body=REPLACE%20THIS%20TEXT%20WITH%20BUG%20DESCRIPTION%20%0A%0AURL:%20../../docs/site/Bug-Reports&labels=bug">Page bug</a> link on the bottom-right of every page opens the Issue Tracker pre-seeded with the current page URL and title.</p> </div> </section> </section> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="FAQ.html" class="btn btn-neutral float-right" title="FAQ"/>Next <span class="fa fa-arrow-circle-right"></span></a> <a href="test-suite.html" class="btn btn-neutral" title="Emscripten Test Suite"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <!--begin hamishw addition --> <!-- --> <!--Footer important links If no such page exists then nav item is not created. CSS defines which of the long or short version is displayed. --> <div class="footer-nav-bar" style=""> <div class="footer-options"> <a class="footer-navlink-short" title="Report Bug" href="#">Report Bug</a><a class="footer-navlink-long" title="Report Bug" href="#">Report Bug</a> <a class="footer-navlink-short" title="Licensing" href="../introducing_emscripten/emscripten_license.html">Licensing</a><a class="footer-navlink-long" title="Licensing" href="../introducing_emscripten/emscripten_license.html">Licensing</a> <a class="footer-navlink-short" title="Contributing" href="../contributing/contributing.html">Contributing</a><a class="footer-navlink-long" title="Contributing" href="../contributing/contributing.html">Contributing</a> <a class="footer-navlink-short external" href="https://groups.google.com/forum/#!forum/emscripten-discuss">Mailing list</a><a class="footer-navlink-long external" href="https://groups.google.com/forum/#!forum/emscripten-discuss">Mailing list</a> <a class="footer-navlink-short external" href="https://github.com/emscripten-core/emscripten/wiki">Wiki</a><a class="footer-navlink-long external" href="https://github.com/emscripten-core/emscripten/wiki">Wiki</a> <a class="footer-navlink-short" title="Release notes" href="../introducing_emscripten/release_notes.html">Release notes</a><a class="footer-navlink-long" title="Release notes" href="../introducing_emscripten/release_notes.html">Release notes</a> <a class="footer-navlink-short" title="Blogs" href="../introducing_emscripten/community.html">Blogs</a><a class="footer-navlink-long" title="Blogs" href="../introducing_emscripten/community.html">Blogs</a> <a class="footer-navlink-short" title="Help" href="../introducing_emscripten/community.html">Help</a><a class="footer-navlink-long" title="Contact" href="../introducing_emscripten/community.html">Contact</a> </div> </div> <!-- <div role="navigation" aria-label="breadcrumbs navigation"> <div class="breadcrumb-box"> <a class="breadcrumb-box-item" href="../../index.html">Home</a> <a class="breadcrumb-box-item" href="index.html">» Getting Started</a> <div class="breadcrumb-box-item">» Bug Reporting</div> </div> </div> --> <!-- <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a> --. <!--end hamishw addition --> <!-- end section moved here by hamishw --> <div role="contentinfo" class="copyright-box"> <!-- section moved here by hamishw - needs tidying, which is why it is still in breadcrumbs mode --> <ul class="wy-breadcrumbs"> <li class="wy-breadcrumbs-aside"> </li> <li class="wy-breadcrumbs-aside"> <a href="../site/about.html">About site</a> </li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/emscripten-core/emscripten/issues/new?title=Bug%20in%20page:Bug%20Reporting%20&body=REPLACE%20THIS%20TEXT%20WITH%20BUG%20DESCRIPTION%20%0A%0AURL:%20../../docs/getting_started/bug_reports&labels=bug">Page bug</a> </li> </ul> <p> <!-- © Copyright 2015, . --> © Copyright 2015, <a href="../contributing/AUTHORS.html">Emscripten Contributors</a>. <!-- update theme to remove the translation stuff here - it was breaking due to link to AUTHORS file. This is a cludge to allow specific link to my authors file --> </p> </div> </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </div> </body> </html>