boostorg / boostorg/fiber

document that library not just app must define BOOST_USE_ASAN

未关闭
#289 1 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
C++
星标
510
派生
123
PR 合并指标
30 天内没有已合并 PR

描述

The documentation says:

> Support for sanitizers
> Sanitizers (GCC/Clang) are confused by the stack switches. **The library (and Boost.Context too) is required to be compiled with property (b2 command-line) context-impl=ucontext and compilers santizer options.** _Users must define BOOST_USE_ASAN before including any Boost.Context headers when linking against Boost binaries._

The italics sentence says to define BOOST_USE_ASAN. Please make the bold sentence also say to define BOOST_USE_ASAN.

Maybe some people would interpret the italics to refer to building the Fiber library but I thought it referred to building only my application which used the Fiber library since it uses terms like "users" which I think means a user of the Fiber library, not maintainers or builders of the library.

The italics sentence also refers to "linking" against the binaries. I think an application links against the Boost binaries. It does not seem to refer to the boost binaries linking against something else.

It took me a long time to figure out why ASAN failed with Fiber until I finally found this [issue](https://github.com/boostorg/context/issues/70). Maybe my suggested change will also help other users.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。