2
0
mirror of https://github.com/boostorg/outcome.git synced 2026-01-19 04:22:13 +00:00
Files
outcome/doc/html/requirements.html
2026-01-18 22:37:02 +00:00

80 lines
3.9 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Prerequisites - Boost.Outcome documentation</title>
<link rel="stylesheet" href="./css/boost.css" type="text/css">
<meta name="generator" content="Hugo 0.52 with Boostdoc theme">
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
<link rel="icon" href="./images/favicon.ico" type="image/ico"/>
<body><div class="spirit-nav">
<a accesskey="p" href="./index.html"><img src="./images/prev.png" alt="Prev"></a>
<a accesskey="u" href="./index.html"><img src="./images/up.png" alt="Up"></a>
<a accesskey="h" href="./index.html"><img src="./images/home.png" alt="Home"></a><a accesskey="n" href="./build.html"><img src="./images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both">Prerequisites</h1></div></div></div>
<p>Outcome is a header-only C++ 14 library known to work well on the latest
point releases of these compiler-platform combinations or better:</p>
<ul>
<li>clang 4.0.1 (LLVM) [FreeBSD, Linux, OS X]</li>
<li>GCC 6.5 [Linux]</li>
<li>Visual Studio 2017.9 [Windows]</li>
<li>XCode 9 [MacOS]</li>
</ul>
<p>For non-Windows non-POSIX platforms (typically embedded systems), Outcome
is usable in its Outcome.Experimental form with the macro <code>BOOST_OUTCOME_SYSTEM_ERROR2_NOT_POSIX</code>
defined.</p>
<p>It is worth turning on C++ 17 or C++ 20 if you can, as there are many usability and
performance improvements. Any Concepts TS or Coroutines TS implemented
by your compiler is automatically detected and used.</p>
<p>Known compiler issues (this was last updated April 2023):</p>
<ul>
<li><p>clang 3.5 - 3.9 can compile varying degrees of the test suite, the
problem is lack of complete and unbuggy C++ 14 language support.</p></li>
<li><p>Older point releases of GCCs 7 and 8 have internal compiler error bugs
in their constexpr implementation which tend to be triggered by using
Outcome in constexpr. If you don&rsquo;t use Outcome in constexpr, you won&rsquo;t
see these problems. If you need your GCC to not ICE, upgrade to the
very latest point release, the constexpr ICE has been since fixed.</p></li>
<li><p>Early editions of Visual Studio 2017 have many corner case problems.
From VS2017.9 onwards there remain a number of usually untroublesome corner
case issues, but use should be relatively unsurprising for most use cases.
Be aware that only from Visual Studio 2022 onwards are almost all corner
case problems fixed.</p></li>
<li><p>Some point releases of GCC 10 with libstdc++ 10 can induce an infinite
template instantiation, which fails the build for some rare use cases. Earlier
or later GCCs or different point releases of the 10 series do not have
this issue.</p></li>
</ul>
<hr />
<p>&ldquo;C++ 14&rdquo; compilers which do not work, and will not work until their
maintainers fix them:</p>
<ul>
<li>GCC 5, due to a bug in nested template variables parsing which was fixed
in GCC 6. I appreciate that this upsets a lot of users. Please raise your
upset at <a href="https://gcc.gnu.org/bugzilla/">https://gcc.gnu.org/bugzilla/</a>. In the meantime, you can get fairly
far in Outcome with even clang 3.5.</li>
<li>Any compiler which uses the libstdc++ version which comes with GCC 5, as it does
not implement enough of the C++ 14 standard library for Outcome to compile.</li>
</ul>
</div><p><small>Last revised: April 18, 2023 at 20:57:50 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="./index.html"><img src="./images/prev.png" alt="Prev"></a>
<a accesskey="u" href="./index.html"><img src="./images/up.png" alt="Up"></a>
<a accesskey="h" href="./index.html"><img src="./images/home.png" alt="Home"></a><a accesskey="n" href="./build.html"><img src="./images/next.png" alt="Next"></a></div></body>
</html>