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 コードの場合は、include_prefix および strip_include_prefix 引数を cc_library ルール ターゲットで使用します。