簡単な導入のための打ち鳴らす-きちんと以前、紙打ち鳴らす・整頓合計するポイントの一部を使用します。
1は、打ち鳴らす・整頓し、実行バッチスクリプトrun-clang-tidy.pyリリースパッケージには、クラン/ LLVMプリコンパイルが、別のディレクトリに配置されています。ここで、打ち鳴らす-整頓で:主要リリースパッケージディレクトリの下の/ binのディレクトリ; run-clang-tidy.pyで:ポストパッケージのホームディレクトリ/共有/打ち鳴らす/ディレクトリの下に。
例えば:
打ち鳴らす+ LLVM-8.0.0-x86_64の-LinuxをGNU-のUbuntu-16.04放出バッグで、例えば、打ち鳴らす、きちんと位置:打ち鳴らす+ LLVM-8.0.0-x86_64の-LinuxをGNU-Ubuntuの-16.04 / binに/ clang-整頓; run-clang-tidy.py位置:打ち鳴らす+ LLVM-8.0.0-x86_64版 - のlinux-gnuの-のubuntu-16.04 /株/打ち鳴らす/ run-clang-tidy.py。
2、run-clang-tidy.pyランニング打ち鳴らす-整頓、およびcompile_commands.jsonに依存しています。同時に、これらはいずれも「-checks =」によって、すべてのルールをチェックするように設定することができます。またははるかに適した書き込み用のルールをカスタマイズして、プロジェクト全体のためにあるプロジェクトの中のルールプロジェクト、筆記試験の下で自分のホームディレクトリに「-checks =」オプションを追加.clang-きちんとファイルを使用しないでください。.clang-きちんとファイルは、ホームディレクトリの下に置かれてはならないが、通常チェックするプロジェクト全体を容易にするために、メインディレクトリの下に配置されます。
例えば:
これは、ホームディレクトリの下に打ち鳴らす.clang-整頓です。
3、操作run-clang-tidy.pyは、打ち鳴らす-整頓にのみ依存するものではなく、だけでなく、打ち鳴らす - 適用 - 代替品に依存します。打ち鳴らす - 適用 - 代替品と同じディレクトリに打ち鳴らす-整頓。
ノートは述べるの始まりrun-clang-tidy.py:「コンパイルデータベース内のすべてのファイルの上に打ち鳴らす-整頓を実行すると、$ PATHに打ち鳴らす-整頓と打ち鳴らす-適用-交換が必要です。」
4、同じディレクトリにrun-clang-tidy.pyプリコンパイルされたリリースのバッグと打ち鳴らす-整頓、打ち鳴らす-適用し、代替品ではないので、あなたはrun-clang-tidy.pyを指定して実行時に「-clang、整頓することができます-binary =「と」-clang-適用-置換バイナリ=「二つのオプション、決定打ち鳴らす、きちんと、打ち鳴らす-適用-代替の経路。
例えば:
プロジェクトのメインディレクトリの下に、あなたのホームディレクトリに、ホームディレクトリでもパッケージの下打ち鳴らす+ LLVM-8.0.0-x86_64版 - のlinux-gnuの-のubuntu-16.04、プリコンパイルされ、同時にリリースされ、.clang-整頓とcompile_commands.jsonの文書が存在します次のコマンドは、プロジェクト全体の検査の下で実行することができます:
./clang+llvm-8.0.0-x86_64-linux-gnu-ubuntu-16.04/share/clang/run-clang-tidy.py -clang-きちんとバイナリ=」/打ち鳴らす+ LLVM-8.0.0-x86_64の-linux-GNU-Ubuntuの-16.04 / binに/打ち鳴らす-整頓 '-clang-適用-置換バイナリ=' /打ち鳴らす+ LLVM-8.0.0-x86_64の-LinuxをGNU-Ubuntuの-16.04 / binに/打ち鳴らす、適用-replacements' ./
図5は、とのルールの名前の前に、打ち鳴らす、きちんと検査ルールを書いている時点「 - 」ルールはルール名は、ルールの使用に直接書き込まれ、失敗することです。
例えば:
のホームディレクトリの打ち鳴らすのルールの下で.clang-きちんとファイル:
チェック: ' - *、打ち鳴らす - 診断 - *、LLVM - *、その他 - *、 - MISC-未使用のパラメータ、-misc-非プライベート・メンバー変数・イン・クラス、-readability識別子命名'
ここで「 - *」「、利用可能misc-の先頭に打ち鳴らす-diagnostic-、llvm-、ルールせることです「 - - *、LLVM *、misc- *打ち鳴らす診断」は、現在のルールのすべてが失敗することです - MISC-未使用のパラメータ、-misc-非プライベート・メンバー変数・イン・クラス、-readability識別子命名「は、これら3つの特定のルールを失敗させることです。
6、位置打ち鳴らす-整頓の公式ドキュメントのチェックリスト:エクストラクラン11のツールのドキュメント。その中で、いくつかのルールは、そのルールの更なるサブセットすることができます。
例えば:
ルール可読性-識別子の命名、それはさらに細分化することができます。その細分化にあるドキュメント:クラン・整頓-可読性識別子-ネーミング。
打ち鳴らす.clang-整頓はまた、このルールの細分化の一部です: