C++ と Bazel

問題を報告 ソースを表示

このページには、C++ プロジェクトで Bazel を使用する場合に役立つリソースが記載されています。このページには、Bazel を使用した C++ プロジェクトのビルドに固有のチュートリアル、ビルドルール、その他の情報へのリンクがあります。

Bazel の使用

次のリソースは、C++ プロジェクトで Bazel を使用する際に役立ちます。

ベスト プラクティス

Bazel の一般的なベスト プラクティスに加えて、C++ プロジェクトに固有のベスト プラクティスを以下に示します。

BUILD ファイル

BUILD ファイルを作成する際は、以下のガイドラインに従ってください。

  • BUILD ファイルには、ディレクトリ内のコンパイル単位ごとに 1 つの cc_library ルール ターゲットを含める必要があります。

  • インクリメンタリティを最大化し、ビルドを並列化するために、可能な限り C++ ライブラリを粒度化する必要があります。

  • srcs にソースファイルが 1 つしかない場合は、ライブラリにその C++ ファイルと同じ名前を付けます。このライブラリには、C++ ファイル、一致するヘッダー ファイル、ライブラリの直接依存関係が含まれている必要があります。次に例を示します。

    cc_library(
        name = "mylib",
        srcs = ["mylib.cc"],
        hdrs = ["mylib.h"],
        deps = [":lower-level-lib"]
    )
    
  • ファイル内の cc_library ターゲットごとに 1 つの cc_test ルール ターゲットを使用します。ターゲット [library-name]_test とソースファイルに [library-name]_test.cc という名前を付けます。たとえば、上記の mylib ライブラリ ターゲットのテスト ターゲットは次のようになります。

    cc_test(
        name = "mylib_test",
        srcs = ["mylib_test.cc"],
        deps = [":mylib"]
    )
    

含めるパス

インクルード パスについては、次のガイドラインに従ってください。

  • すべてのインクルード パスは、ワークスペース ディレクトリからの相対パスにします。

  • システム以外のヘッダーには、山かっこ(#include <foo/bar/baz.h>)ではなく、引用符で囲まれたインクルード(#include "foo/bar/baz.h")を使用します。

  • .(現在のディレクトリ)や ..(親ディレクトリ)などの UNIX ディレクトリ ショートカットは使用しないでください。

  • プロジェクト リポジトリ以外を指定する必要がある以前のコードまたは third_party コード(外部リポジトリに接頭辞を必要とする場合など)の場合は、cc_library ルール ターゲットで include_prefix 引数と strip_include_prefix 引数を使用します。