From b7958bc83e08ec01f3de1804984d875bfec84cb6 Mon Sep 17 00:00:00 2001 From: Antony Polukhin Date: Tue, 11 Oct 2016 23:25:04 +0300 Subject: [PATCH] Docs regenerated --- boost/stacktrace/stacktrace.html | 38 +-- .../build_macros_and_backends.html | 290 ++++++++++++++++++ boost_stacktrace/getting_started.html | 36 ++- boost_stacktrace_header_reference.html | 8 +- index.html | 6 +- standalone_HTML.manifest | 1 + 6 files changed, 352 insertions(+), 27 deletions(-) create mode 100644 boost_stacktrace/build_macros_and_backends.html diff --git a/boost/stacktrace/stacktrace.html b/boost/stacktrace/stacktrace.html index 7cac170..b11851e 100644 --- a/boost/stacktrace/stacktrace.html +++ b/boost/stacktrace/stacktrace.html @@ -34,44 +34,44 @@ class stacktrace { public: // construct/copy/destruct - stacktrace() noexcept; - stacktrace(const stacktrace &) noexcept; - stacktrace & operator=(const stacktrace &) noexcept; - ~stacktrace(); + stacktrace() noexcept; + stacktrace(const stacktrace &) noexcept; + stacktrace & operator=(const stacktrace &) noexcept; + ~stacktrace(); - // public member functions - std::size_t size() const noexcept; - std::string operator[](std::size_t) const; - bool operator!() const noexcept; + // public member functions + std::size_t size() const noexcept; + std::string operator[](std::size_t) const; + bool operator!() const noexcept; };
-

Description

+

Description

-

+

stacktrace public construct/copy/destruct

  1. -
    stacktrace() noexcept;
    Stores the current function call sequence inside the class.

    Complexity: O(N) where N is call seaquence length, O(1) for noop backend.

    +
    stacktrace() noexcept;
    Stores the current function call sequence inside the class.

    Complexity: O(N) where N is call seaquence length, O(1) for noop backend.

  2. -
    stacktrace(const stacktrace & bt) noexcept;
    +
    stacktrace(const stacktrace & bt) noexcept;
    Complexity: O(1)
  3. -
    stacktrace & operator=(const stacktrace & bt) noexcept;
    +
    stacktrace & operator=(const stacktrace & bt) noexcept;
    Complexity: O(1)
  4. -
    ~stacktrace();
    +
    ~stacktrace();
    Complexity: O(N) for libunwind, O(1) for other backends.
-

-stacktrace public member functions

+

+stacktrace public member functions

  1. -
    std::size_t size() const noexcept;
    +
    std::size_t size() const noexcept;

    Complexity: O(1)

    @@ -83,7 +83,7 @@
  2. -
    std::string operator[](std::size_t frame) const;
    +
    std::string operator[](std::size_t frame) const;

    @@ -112,7 +112,7 @@

-
  • bool operator!() const noexcept;
    • +
  • bool operator!() const noexcept;
    • diff --git a/boost_stacktrace/build_macros_and_backends.html b/boost_stacktrace/build_macros_and_backends.html new file mode 100644 index 0000000..b656682 --- /dev/null +++ b/boost_stacktrace/build_macros_and_backends.html @@ -0,0 +1,290 @@ + + + +Build, Macros and Backends + + + + + + + + + + + + + + + +
    Boost C++ LibrariesHomeLibrariesPeopleFAQMore
    +
    +
    +PrevUpHomeNext +
    +
    +

    +Build, Macros + and Backends +

    +

    + By default Boost.Stacktrace is a header-only library and it attempts to detect + the tracing backend automatically. +

    +

    + 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 + BOOST_STACKTRACE_LINK or BOOST_STACKTRACE_DYN_LINK): +

    +
    +

    Table 1.1. Header only backend specifications

    +
    +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    + Macro name +

    +     		+

    + Effect +

    +     		+

    + Platforms +

    +     		+

    + Uses debug information [a] +

    +     		+

    + Uses dynamic exports information [b] +

    +
    +

    + BOOST_STACKTRACE_USE_LIBUNWIND +

    +     		+

    + Use libunwind tracing backend. This is the best known backend for + POSIX systems that requires linking with libunwind library. +

    +     		+

    + POSIX +

    +     		+

    + yes +

    +     		+

    + yes +

    +
    +

    + BOOST_STACKTRACE_USE_WINDBG +

    +     		+

    + 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. +

    +     		+

    + Windows +

    +     		+

    + yes +

    +     		+

    + yes +

    +
    +

    + BOOST_STACKTRACE_USE_BACKTRACE +

    +     		+

    + Use tracing backend that calls POSIX function backtrace. This is + a fallback backend for POSIX platforms that requires linking with + libdl library. +

    +     		+

    + POSIX +

    +     		+

    + no +

    +     		+

    + yes +

    +
    +

    + BOOST_STACKTRACE_USE_NOOP +

    +     		+

    + Use noop tracing backend that does nothing. Use this backend if you + wish to disable backtracing. +

    +     		+

    + POSIX and Windows +

    +     		+

    + no +

    +     		+

    + no +

    +
    +

    [a] + This will provide more readable backtraces if the binary is build + with debug information. +

    +

    [b] + This will provide readable function names in backtrace for functions + that are exported by the binary. +

    +
    +
    +

    + You may use following macro to improve build times or to be able to switch + backends without recompiling your project: +

    +
    +

    Table 1.2. Link macros

    +
    ++++ + + + + + + + + + + + + + + +
    +

    + Macro name +

    +     		+

    + Effect +

    +
    +

    + BOOST_STACKTRACE_LINK +

    +     		+

    + Disable header-only build and require linking with shared or static + library that has contains the tracing backend. If BOOST_ALL_DYN_LINK + is defined - link with shared library. +

    +
    +

    + BOOST_STACKTRACE_DYN_LINK +

    +     		+

    + Disable header-only build and require linking with shared library + that has contains tracing backend. +

    +
    +
    +

    + If one of the link macros defined you have to manually link your binary with + one of the libraries that has the backend implementation: +

    +
      +
    • + boost_stacktrace_libunwind +
      • +
    • + boost_stacktrace_windbg +
      • +
    • + boost_stacktrace_backtrace +
      • +
    • + boost_stacktrace_noop +
      • +
    +
    + + + +
    Copyright © 2016 Antony Polukhin

    + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

    +
    +
    +
    +PrevUpHomeNext +
    + + diff --git a/boost_stacktrace/getting_started.html b/boost_stacktrace/getting_started.html index 831500e..21e02b6 100644 --- a/boost_stacktrace/getting_started.html +++ b/boost_stacktrace/getting_started.html @@ -7,7 +7,7 @@ - + @@ -20,7 +20,7 @@
    -PrevUpHomeNext +PrevUpHomeNext

    @@ -33,6 +33,8 @@ Terminates and Segmentation Faults
    Exceptions with Stacktrace
    +
    Enabling + and Disabling stacktraces

    @@ -281,6 +283,34 @@ 17# ??

    +
    +
    +

    + At some point arises a requirement to easily enable/disable stacktraces for + a whole project. That could be easily achived. +

    +

    + Just define BOOST_STACKTRACE_LINK for a + whole project. Now you can enable/disable stacktraces by just linking with + different backends: +

    +
      +
    • + link with boost_stacktrace_noop + to disable backtracing +
      • +
    • + link with other backends to output becktraces +
      • +
    +

    + See section "Build, + Macros and Backends" for more info. +

    +
    @@ -292,7 +322,7 @@
    -PrevUpHomeNext +PrevUpHomeNext
    diff --git a/boost_stacktrace_header_reference.html b/boost_stacktrace_header_reference.html index 59aed7c..e36f519 100644 --- a/boost_stacktrace_header_reference.html +++ b/boost_stacktrace_header_reference.html @@ -6,7 +6,7 @@ - + @@ -20,7 +20,7 @@
    -PrevUpHomeNext +PrevUpHomeNext

    @@ -36,7 +36,7 @@ // Outputs stacktrace in a human readable format to output stream. template<typename CharT, typename TraitsT> std::basic_ostream< CharT, TraitsT > & - operator<<(std::basic_ostream< CharT, TraitsT > & os, + operator<<(std::basic_ostream< CharT, TraitsT > & os, const stacktrace & bt); } } @@ -52,7 +52,7 @@
    -PrevUpHomeNext +PrevUpHomeNext
    diff --git a/index.html b/index.html index 8e9ac77..e94f49f 100644 --- a/index.html +++ b/index.html @@ -42,7 +42,11 @@ Terminates and Segmentation Faults
    Exceptions with Stacktrace
    +
    Enabling + and Disabling stacktraces
    +
    Build, Macros + and Backends
    Boost.Stacktrace Header Reference
    Header <boost/stacktrace.hpp>
    @@ -83,7 +87,7 @@

    - +

    Last revised: September 14, 2016 at 20:36:20 GMT

    Last revised: October 11, 2016 at 20:24:33 GMT
    diff --git a/standalone_HTML.manifest b/standalone_HTML.manifest index 24ee2f7..9d32192 100644 --- a/standalone_HTML.manifest +++ b/standalone_HTML.manifest @@ -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