boost/stacktrace
2
0
Fork 0
mirror of https://github.com/boostorg/stacktrace.git synced 2026-01-23 18:12:11 +00:00
Code Issues Projects Releases Wiki Activity

Docs regenerated

Browse Source
This commit is contained in:
Antony Polukhin
2016-10-11 23:25:04 +03:00
parent b4084a772f
commit b7958bc83e
6 changed files with 352 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
boost/stacktrace/stacktrace.html
View File

@@ -34,44 +34,44 @@
<span class="keyword">class</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="stacktrace.html#boost.stacktrace.stacktraceconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="stacktrace.html#idm46186445808448-bb"><span class="identifier">stacktrace</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
<a class="link" href="stacktrace.html#idm46186445806688-bb"><span class="identifier">stacktrace</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
<a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> <a class="link" href="stacktrace.html#idm46186445804144-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
<a class="link" href="stacktrace.html#idm46186445801024-bb"><span class="special">~</span><span class="identifier">stacktrace</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="stacktrace.html#idm45872242682544-bb"><span class="identifier">stacktrace</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
<a class="link" href="stacktrace.html#idm45872242680784-bb"><span class="identifier">stacktrace</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
<a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> <a class="link" href="stacktrace.html#idm45872242678240-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
<a class="link" href="stacktrace.html#idm45872242675120-bb"><span class="special">~</span><span class="identifier">stacktrace</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="stacktrace.html#idm46186445818384-bb">public member functions</a></span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="stacktrace.html#idm46186445817824-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="stacktrace.html#idm46186445815184-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="stacktrace.html#idm46186445809728-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
<span class="comment">// <a class="link" href="stacktrace.html#idm45872242692240-bb">public member functions</a></span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="stacktrace.html#idm45872242691680-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="stacktrace.html#idm45872242689040-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="stacktrace.html#idm45872242683824-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm45703231280288"></a><h2>Description</h2>
<a name="idm46168682526512"></a><h2>Description</h2>
<div class="refsect2">
<a name="idm45703231279904"></a><h3>
<a name="idm46168682526128"></a><h3>
<a name="boost.stacktrace.stacktraceconstruct-copy-destruct"></a><code class="computeroutput">stacktrace</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idm46186445808448-bb"></a><span class="identifier">stacktrace</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Stores the current function call sequence inside the class. <p><span class="bold"><strong>Complexity:</strong></span> O(N) where N is call seaquence length, O(1) for noop backend. </p>
<pre class="literallayout"><a name="idm45872242682544-bb"></a><span class="identifier">stacktrace</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Stores the current function call sequence inside the class. <p><span class="bold"><strong>Complexity:</strong></span> O(N) where N is call seaquence length, O(1) for noop backend. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idm46186445806688-bb"></a><span class="identifier">stacktrace</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> bt<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<pre class="literallayout"><a name="idm45872242680784-bb"></a><span class="identifier">stacktrace</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> bt<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<span class="bold"><strong>Complexity:</strong></span> O(1) </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> <a name="idm46186445804144-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> bt<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<pre class="literallayout"><a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> <a name="idm45872242678240-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> bt<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<span class="bold"><strong>Complexity:</strong></span> O(1) </li>
<li class="listitem">
<pre class="literallayout"><a name="idm46186445801024-bb"></a><span class="special">~</span><span class="identifier">stacktrace</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<pre class="literallayout"><a name="idm45872242675120-bb"></a><span class="special">~</span><span class="identifier">stacktrace</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<span class="bold"><strong>Complexity:</strong></span> O(N) for libunwind, O(1) for other backends. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="idm45703231254064"></a><h3>
<a name="idm46186445818384-bb"></a><code class="computeroutput">stacktrace</code> public member functions</h3>
<a name="idm46168682500288"></a><h3>
<a name="idm45872242692240-bb"></a><code class="computeroutput">stacktrace</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm46186445817824-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45872242691680-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<p>
<span class="bold"><strong>Complexity:</strong></span> O(1) </p>
<div class="variablelist"><table border="0">
@@ -83,7 +83,7 @@
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46186445815184-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> frame<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm45872242689040-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> frame<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>
@@ -112,7 +112,7 @@
</tbody>
</table></div>
</li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46186445809728-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45872242683824-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>

290
boost_stacktrace/build_macros_and_backends.html Normal file
View File

@@ -0,0 +1,290 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Build, Macros and Backends</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/1_61_0/doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="prev" href="getting_started.html" title="Getting Started">
<link rel="next" href="../boost_stacktrace_header_reference.html" title="Boost.Stacktrace Header Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="http://www.boost.org/doc/libs/1_61_0/boost.png"></td>
<td align="center"><a href="http://www.boost.org/doc/libs/1_61_0/index.html">Home</a></td>
<td align="center"><a href="http://www.boost.org/doc/libs/1_61_0/libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="http://www.boost.org/doc/libs/1_61_0/more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="getting_started.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost_stacktrace_header_reference.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_stacktrace.build_macros_and_backends"></a><a class="link" href="build_macros_and_backends.html" title="Build, Macros and Backends">Build, Macros
and Backends</a>
</h2></div></div></div>
<p>
By default Boost.Stacktrace is a header-only library and it attempts to detect
the tracing backend automatically.
</p>
<p>
You can define the following macros to explicitly specify backend that you're
willing to use in header-only mode (those macros have no effect if defined
<span class="bold"><strong>BOOST_STACKTRACE_LINK</strong></span> or <span class="bold"><strong>BOOST_STACKTRACE_DYN_LINK</strong></span>):
</p>
<div class="table">
<a name="boost_stacktrace.build_macros_and_backends.configbackend"></a><p class="title"><b>Table&#160;1.1.&#160;Header only backend specifications</b></p>
<div class="table-contents"><table class="table" summary="Header only backend specifications">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Macro name
</p>
</th>
<th>
<p>
Effect
</p>
</th>
<th>
<p>
Platforms
</p>
</th>
<th>
<p>
Uses debug information <sup>[<a name="boost_stacktrace.build_macros_and_backends.f0" href="#ftn.boost_stacktrace.build_macros_and_backends.f0" class="footnote">a</a>]</sup>
</p>
</th>
<th>
<p>
Uses dynamic exports information <sup>[<a name="boost_stacktrace.build_macros_and_backends.f1" href="#ftn.boost_stacktrace.build_macros_and_backends.f1" class="footnote">b</a>]</sup>
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<span class="bold"><strong>BOOST_STACKTRACE_USE_LIBUNWIND</strong></span>
</p>
</td>
<td>
<p>
Use libunwind tracing backend. This is the best known backend for
POSIX systems that requires linking with libunwind library.
</p>
</td>
<td>
<p>
POSIX
</p>
</td>
<td>
<p>
yes
</p>
</td>
<td>
<p>
yes
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><strong>BOOST_STACKTRACE_USE_WINDBG</strong></span>
</p>
</td>
<td>
<p>
Use Windows specific tracing backend that uses DbgHelp. This is the
best and only known backend for Windows platform that requires linking
with DbgHelp library.
</p>
</td>
<td>
<p>
Windows
</p>
</td>
<td>
<p>
yes
</p>
</td>
<td>
<p>
yes
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><strong>BOOST_STACKTRACE_USE_BACKTRACE</strong></span>
</p>
</td>
<td>
<p>
Use tracing backend that calls POSIX function backtrace. This is
a fallback backend for POSIX platforms that requires linking with
libdl library.
</p>
</td>
<td>
<p>
POSIX
</p>
</td>
<td>
<p>
no
</p>
</td>
<td>
<p>
yes
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><strong>BOOST_STACKTRACE_USE_NOOP</strong></span>
</p>
</td>
<td>
<p>
Use noop tracing backend that does nothing. Use this backend if you
wish to disable backtracing.
</p>
</td>
<td>
<p>
POSIX and Windows
</p>
</td>
<td>
<p>
no
</p>
</td>
<td>
<p>
no
</p>
</td>
</tr>
</tbody>
<tbody class="footnotes"><tr><td colspan="5">
<div class="footnote"><p><sup>[<a name="ftn.boost_stacktrace.build_macros_and_backends.f0" href="#boost_stacktrace.build_macros_and_backends.f0" class="para">a</a>] </sup>
This will provide more readable backtraces if the binary is build
with debug information.
</p></div>
<div class="footnote"><p><sup>[<a name="ftn.boost_stacktrace.build_macros_and_backends.f1" href="#boost_stacktrace.build_macros_and_backends.f1" class="para">b</a>] </sup>
This will provide readable function names in backtrace for functions
that are exported by the binary.
</p></div>
</td></tr></tbody>
</table></div>
</div>
<br class="table-break"><p>
You may use following macro to improve build times or to be able to switch
backends without recompiling your project:
</p>
<div class="table">
<a name="boost_stacktrace.build_macros_and_backends.linkmacro"></a><p class="title"><b>Table&#160;1.2.&#160;Link macros</b></p>
<div class="table-contents"><table class="table" summary="Link macros">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Macro name
</p>
</th>
<th>
<p>
Effect
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<span class="bold"><strong>BOOST_STACKTRACE_LINK</strong></span>
</p>
</td>
<td>
<p>
Disable header-only build and require linking with shared or static
library that has contains the tracing backend. If <span class="bold"><strong>BOOST_ALL_DYN_LINK</strong></span>
is defined - link with shared library.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><strong>BOOST_STACKTRACE_DYN_LINK</strong></span>
</p>
</td>
<td>
<p>
Disable header-only build and require linking with shared library
that has contains tracing backend.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><p>
If one of the link macros defined you have to manually link your binary with
one of the libraries that has the backend implementation:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
boost_stacktrace_libunwind
</li>
<li class="listitem">
boost_stacktrace_windbg
</li>
<li class="listitem">
boost_stacktrace_backtrace
</li>
<li class="listitem">
boost_stacktrace_noop
</li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016 Antony Polukhin<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="getting_started.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost_stacktrace_header_reference.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

36
boost_stacktrace/getting_started.html
View File

@@ -7,7 +7,7 @@
<link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="prev" href="../index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="next" href="../boost_stacktrace_header_reference.html" title="Boost.Stacktrace Header Reference">
<link rel="next" href="build_macros_and_backends.html" title="Build, Macros and Backends">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost_stacktrace_header_reference.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
<a accesskey="p" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="build_macros_and_backends.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -33,6 +33,8 @@
Terminates and Segmentation Faults</a></span></dt>
<dt><span class="section"><a href="getting_started.html#boost_stacktrace.getting_started.exceptions_with_stacktrace">Exceptions
with Stacktrace</a></span></dt>
<dt><span class="section"><a href="getting_started.html#boost_stacktrace.getting_started.enabling_and_disabling_stacktrac">Enabling
and Disabling stacktraces</a></span></dt>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
@@ -281,6 +283,34 @@
<span class="number">17</span><span class="special">#</span> <span class="special">??</span>
</pre>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_stacktrace.getting_started.enabling_and_disabling_stacktrac"></a><a class="link" href="getting_started.html#boost_stacktrace.getting_started.enabling_and_disabling_stacktrac" title="Enabling and Disabling stacktraces">Enabling
and Disabling stacktraces</a>
</h3></div></div></div>
<p>
At some point arises a requirement to easily enable/disable stacktraces for
a whole project. That could be easily achived.
</p>
<p>
Just define <span class="bold"><strong>BOOST_STACKTRACE_LINK</strong></span> for a
whole project. Now you can enable/disable stacktraces by just linking with
different backends:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
link with <code class="computeroutput"><span class="identifier">boost_stacktrace_noop</span></code>
to disable backtracing
</li>
<li class="listitem">
link with other backends to output becktraces
</li>
</ul></div>
<p>
See <a class="link" href="build_macros_and_backends.html" title="Build, Macros and Backends">section "Build,
Macros and Backends"</a> for more info.
</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -292,7 +322,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost_stacktrace_header_reference.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
<a accesskey="p" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="build_macros_and_backends.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

8
boost_stacktrace_header_reference.html
View File

@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="up" href="index.html" title="Chapter&#160;1.&#160;Boost.Stacktrace 1.0">
<link rel="prev" href="boost_stacktrace/getting_started.html" title="Getting Started">
<link rel="prev" href="boost_stacktrace/build_macros_and_backends.html" title="Build, Macros and Backends">
<link rel="next" href="boost/stacktrace/stacktrace.html" title="Class stacktrace">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost_stacktrace/getting_started.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost/stacktrace/stacktrace.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
<a accesskey="p" href="boost_stacktrace/build_macros_and_backends.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost/stacktrace/stacktrace.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -36,7 +36,7 @@
<span class="comment">// Outputs stacktrace in a human readable format to output stream. </span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">&gt;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
<a name="boost.stacktrace.operator_idm46186445799920"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span>
<a name="boost.stacktrace.operator_idm45872242674016"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="boost/stacktrace/stacktrace.html" title="Class stacktrace">stacktrace</a> <span class="special">&amp;</span> bt<span class="special">)</span><span class="special">;</span>
<span class="special">}</span>
<span class="special">}</span></pre>
@@ -52,7 +52,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost_stacktrace/getting_started.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost/stacktrace/stacktrace.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
<a accesskey="p" href="boost_stacktrace/build_macros_and_backends.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost/stacktrace/stacktrace.html"><img src="http://www.boost.org/doc/libs/1_61_0/doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

6
index.html
View File

@@ -42,7 +42,11 @@
Terminates and Segmentation Faults</a></span></dt>
<dt><span class="section"><a href="boost_stacktrace/getting_started.html#boost_stacktrace.getting_started.exceptions_with_stacktrace">Exceptions
with Stacktrace</a></span></dt>
<dt><span class="section"><a href="boost_stacktrace/getting_started.html#boost_stacktrace.getting_started.enabling_and_disabling_stacktrac">Enabling
and Disabling stacktraces</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_stacktrace/build_macros_and_backends.html">Build, Macros
and Backends</a></span></dt>
<dt><span class="section"><a href="boost_stacktrace_header_reference.html">Boost.Stacktrace Header Reference</a></span></dt>
<dd><dl><dt><span class="section"><a href="boost_stacktrace_header_reference.html#header.boost.stacktrace_hpp">Header &lt;boost/stacktrace.hpp&gt;</a></span></dt></dl></dd>
</dl>
@@ -83,7 +87,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: September 14, 2016 at 20:36:20 GMT</small></p></td>
<td align="left"><p><small>Last revised: October 11, 2016 at 20:24:33 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

1
standalone_HTML.manifest
View File

@@ -1,4 +1,5 @@
index.html
boost_stacktrace/getting_started.html
boost_stacktrace/build_macros_and_backends.html
boost_stacktrace_header_reference.html
boost/stacktrace/stacktrace.html