mapbox / mapbox/cpp

Recommendations for which sanitizers to enable

オープン
#41 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
言語のデータがありません
スター
110
フォーク
17
PR マージ指標
30日以内にマージされた PR はありません

説明

As time passes, the g++/clang++ gain more new sanitizers, existing ones get better, and some get ported to new platforms (e.g. recently leak support was added to OS X in clang++ 5).

Similar to #37 for warnings, This ticket can serve as a central place to start documenting a recommended list of sanitizer flags to use. I intend this to be a quick, opinionated reference to check before you would dive deeper into docs like https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html.

The relevant questions I see are:

  • 🍇 Which sanitizers should we always test with?
  • 🍊 Which additional flags or environment variables should we use?
  • 🍏 Which additional flags should be used when testing the sanitizers on CI systems?
  • 🍎 Which additional flags should be used when building sanitized binaries for live testing?

Refs:

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、参照されている Sanitizers.def ファイル内の sanitizer のグループ分けを、AddressSanitizer、ThreadSanitizer、MemorySanitizer、UndefinedBehaviorSanitizer、DataFlowSanitizer、LeakSanitizer、Control Flow Integrity、Safe Stack のドキュメントと比較します。常時有効なテスト、CI、ライブテスト用ビルドについて、関連する flags、環境変数、プラットフォームの制限を含めて推奨事項を明確にします。これらの質問を網羅した、簡潔で明確な方針を示すリファレンスが issue に含まれていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
documentation, testing-qa
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。