C++ dan Bazel

Laporkan masalah Lihat sumber

Halaman ini berisi referensi yang membantu Anda menggunakan Bazel dengan project C++. Referensi ini terhubung ke tutorial, aturan build, dan informasi lain khusus untuk membangun project C++ dengan Bazel.

Bekerja dengan Bazel

Referensi berikut akan membantu Anda bekerja dengan Bazel pada project C++:

Praktik terbaik

Selain praktik terbaik umum Bazel, berikut ini praktik terbaik khusus project C++.

BANGUN file

Ikuti panduan di bawah ini saat membuat file BUILD:

  • Setiap file BUILD harus berisi satu target aturan cc_library per unit kompilasi dalam direktori.

  • Anda harus menguraikan library C++ sebanyak mungkin untuk memaksimalkan inkrementalitas dan memparalelkan build.

  • Jika ada satu file sumber di srcs, beri nama library sama dengan nama file C++ tersebut. Library ini harus berisi file C++, file header apa pun yang cocok, dan dependensi langsung library. Contoh:

    cc_library(
    name = "mylib",
    srcs = ["mylib.cc"],
    hdrs = ["mylib.h"],
    deps = [":lower-level-lib"]
)

  • Gunakan satu target aturan cc_test per target cc_library dalam file. Beri nama [library-name]_test target dan file sumber [library-name]_test.cc. Misalnya, target pengujian untuk target library mylib yang ditunjukkan di atas akan terlihat seperti ini:

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

Sertakan jalur

Ikuti panduan berikut untuk jalur penyertaan:

  • Buat semua jalur penyertaan relatif terhadap direktori ruang kerja.

  • Gunakan tanda kutip (#include "foo/bar/baz.h") untuk header non-sistem, bukan tanda kurung sudut (#include <foo/bar/baz.h>).

  • Hindari penggunaan pintasan direktori UNIX, seperti . (direktori saat ini) atau .. (direktori induk).

  • Untuk kode lama atau third_party yang mengharuskan penyertaan mengarah ke luar repositori project, seperti yang menyertakan repositori eksternal yang mewajibkan awalan, gunakan argumen include_prefix dan strip_include_prefix pada target aturan cc_library.

Fitur toolchain

Fitur opsional berikut dapat meningkatkan kebersihan project C++. Fitur ini dapat diaktifkan menggunakan tanda command line --features atau atribut features dari aturan repo, package, atau cc_*:

  • Fitur parse_headers membuat compiler C++ digunakan untuk mengurai (tetapi tidak mengompilasi) semua file header dalam target yang telah dibuat dan dependensinya saat menggunakan flag --process_headers_in_dependencies. Hal ini dapat membantu menemukan masalah di library khusus header dan memastikan bahwa header bersifat mandiri dan tidak bergantung pada urutan penyertaannya.
  • Fitur layering_check memastikan bahwa target hanya menyertakan header yang disediakan oleh dependensi langsungnya. Toolchain default mendukung fitur ini di Linux dengan clang sebagai compilernya.