BazelCon 2024 đăng ký và CFP hiện đã mở!
Để xem tài liệu về bản phát hành ổn định, vui lòng sử dụng trình đơn thả xuống "Tài liệu đã tạo phiên bản". Chế độ xem mặc định phản ánh phiên bản mới nhất ở HEAD.

Trang này được dịch bởi Cloud Translation API.

Ghi tệp cấu hình bazelrc

Báo cáo vấn đề Xem nguồn Nightly .

Bazel chấp nhận nhiều lựa chọn. Một số tuỳ chọn thường xuyên thay đổi (ví dụ: --subcommands) trong khi các tuỳ chọn khác vẫn giữ nguyên trên nhiều bản dựng (chẳng hạn như --package_path). Để tránh chỉ định các tuỳ chọn không thay đổi này cho mỗi bản dựng (và các lệnh khác), bạn có thể chỉ định các tuỳ chọn trong tệp cấu hình, có tên là .bazelrc.

Tệp `.bazelrc` nằm ở đâu?

Bazel tìm kiếm các tệp cấu hình không bắt buộc ở các vị trí sau, theo thứ tự hiển thị dưới đây. Các tùy chọn được diễn giải theo thứ tự này, vì vậy, các tùy chọn trong các tệp sau này có thể ghi đè giá trị từ tệp trước đó nếu xảy ra xung đột. Mọi tuỳ chọn kiểm soát tệp nào trong số này được tải đều là tuỳ chọn khởi động, nghĩa là các tuỳ chọn này phải xuất hiện sau bazel và trước lệnh (build, test, v.v.).

Tệp RC hệ thống, trừ phi có --nosystem_rc.

Đường dẫn:
- Trên Linux/macOS/Unixes: /etc/bazel.bazelrc
- Trên Windows: %ProgramData%\bazel.bazelrc
Nếu tệp này không tồn tại thì không phải là lỗi.

Nếu cần một vị trí khác do hệ thống chỉ định, bạn phải tạo tệp nhị phân Bazel tuỳ chỉnh, ghi đè giá trị BAZEL_SYSTEM_BAZELRC_PATH trong //src/main/cpp:option_processor. Vị trí do hệ thống chỉ định có thể chứa các tệp tham chiếu biến môi trường, chẳng hạn như ${VAR_NAME} trên Unix hoặc %VAR_NAME% trên Windows.
Tệp RC không gian làm việc, trừ phi có --noworkspace_rc.

Đường dẫn: .bazelrc trong thư mục không gian làm việc (bên cạnh tệp WORKSPACE chính).

Nếu tệp này không tồn tại thì không phải là lỗi.
Tệp RC tại nhà, trừ phi có --nohome_rc.

Đường dẫn:
- Trên Linux/macOS/Unixes: $HOME/.bazelrc
- Trên Windows: %USERPROFILE%\.bazelrc nếu tồn tại hoặc %HOME%/.bazelrc
Nếu tệp này không tồn tại thì không phải là lỗi.
Tệp RC do người dùng chỉ định, nếu được chỉ định bằng --bazelrc=file

Cờ này là không bắt buộc nhưng cũng có thể được chỉ định nhiều lần.

/dev/null cho biết rằng tất cả các --bazelrc khác sẽ bị bỏ qua. Điều này rất hữu ích khi tắt tính năng tìm kiếm tệp rc của người dùng, chẳng hạn như trong các bản phát hành.

Ví dụ:
```
--bazelrc=x.rc --bazelrc=y.rc --bazelrc=/dev/null --bazelrc=z.rc
```
- x.rc và y.rc đã được đọc.
- z.rc bị bỏ qua do /dev/null trước đó.

Ngoài tệp cấu hình không bắt buộc này, Bazel còn tìm một tệp rc chung. Để biết thêm thông tin chi tiết, hãy xem mục Bazelrc toàn cầu.

Cú pháp và ngữ nghĩa `.bazelrc`

Giống như mọi tệp "rc" UNIX, tệp .bazelrc là tệp văn bản có ngữ pháp dựa trên dòng. Các dòng trống và dòng bắt đầu bằng # (nhận xét) sẽ bị bỏ qua. Mỗi dòng chứa một chuỗi các từ, được mã hoá theo các quy tắc tương tự như shell Bourne.

Nhập

Các dòng bắt đầu bằng import hoặc try-import là các dòng đặc biệt: hãy sử dụng các dòng này để tải các tệp "rc" khác. Để chỉ định một đường dẫn tương ứng với thư mục gốc của không gian làm việc, hãy ghi import %workspace%/path/to/bazelrc.

Sự khác biệt giữa import và try-import là Bazel sẽ gặp lỗi nếu tệp của import bị thiếu (hoặc không thể đọc), nhưng đối với tệp try-import thì không.

Ưu tiên nhập:

Các tuỳ chọn trong tệp đã nhập được ưu tiên hơn các tuỳ chọn được chỉ định trước câu lệnh nhập.
Các tuỳ chọn được chỉ định sau câu lệnh nhập sẽ được ưu tiên so với các tuỳ chọn trong tệp đã nhập.
Lựa chọn trong các tệp được nhập sau sẽ được ưu tiên so với các tệp được nhập trước đó.

Giá trị mặc định của lựa chọn

Hầu hết các dòng của bazelrc đều xác định các giá trị tuỳ chọn mặc định. Từ đầu tiên trên mỗi dòng chỉ định thời điểm áp dụng các giá trị mặc định này:

startup: các tuỳ chọn khởi động nằm trước lệnh và được mô tả trong bazel help startup_options.
common: các tuỳ chọn nên được áp dụng cho mọi lệnh Bazel hỗ trợ các lệnh đó. Nếu một lệnh không hỗ trợ một tuỳ chọn được chỉ định theo cách này, thì tuỳ chọn đó sẽ bị bỏ qua miễn là nó hợp lệ với một số lệnh Bazel khác. Xin lưu ý rằng điều này chỉ áp dụng cho tên tuỳ chọn: Nếu lệnh hiện tại chấp nhận một tuỳ chọn có tên đã chỉ định, nhưng không hỗ trợ giá trị đã chỉ định, thì tuỳ chọn sẽ không thành công.
always: các tuỳ chọn áp dụng cho mọi lệnh Bazel. Nếu một lệnh không hỗ trợ tuỳ chọn được chỉ định theo cách này, thì lệnh đó sẽ không thành công.
command: Lệnh Bazel, chẳng hạn như build hoặc query mà các tuỳ chọn áp dụng. Các tuỳ chọn này cũng áp dụng cho tất cả lệnh kế thừa từ lệnh được chỉ định. (Ví dụ: test kế thừa từ build.)

Bạn có thể sử dụng mỗi dòng này nhiều lần và các đối số theo sau từ đầu tiên được kết hợp như thể chúng đã xuất hiện trên một dòng. (Người dùng CVS, một công cụ khác có giao diện dòng lệnh "Swiss army knife" sẽ thấy cú pháp tương tự như cú pháp của .cvsrc.) Ví dụ: các dòng:

build --test_tmpdir=/tmp/foo --verbose_failures
build --test_tmpdir=/tmp/bar

được kết hợp thành:

build --test_tmpdir=/tmp/foo --verbose_failures --test_tmpdir=/tmp/bar

vì vậy, cờ có hiệu lực là --verbose_failures và --test_tmpdir=/tmp/bar.

Mức độ ưu tiên của lựa chọn:

Các tuỳ chọn trên dòng lệnh luôn được ưu tiên hơn các tuỳ chọn trong tệp rc. Ví dụ: nếu tệp rc cho biết build -c opt nhưng cờ dòng lệnh là -c dbg, thì cờ dòng lệnh sẽ được ưu tiên.
Trong tệp rc, mức độ ưu tiên chịu sự điều chỉnh của mức độ cụ thể: các dòng cho lệnh cụ thể hơn sẽ được ưu tiên hơn các dòng cho một lệnh ít cụ thể hơn.

Tính cụ thể được xác định theo tính kế thừa. Một số lệnh kế thừa tuỳ chọn từ các lệnh khác, khiến lệnh kế thừa cụ thể hơn so với lệnh cơ sở. Ví dụ: test kế thừa từ lệnh build, vì vậy, tất cả cờ bazel build đều hợp lệ với bazel test và tất cả các dòng build cũng áp dụng cho bazel test trừ phi có một dòng test cho cùng tuỳ chọn. Nếu tệp rc cho biết:
```
test -c dbg --test_env=PATH
build -c opt --verbose_failures
```
thì bazel build //foo sẽ sử dụng -c opt --verbose_failures và bazel test //foo sẽ sử dụng --verbose_failures -c dbg --test_env=PATH.

Biểu đồ tính kế thừa (quy cách) là:
- Mọi lệnh đều kế thừa từ common
- Các lệnh sau kế thừa từ (và cụ thể hơn) build: test, run, clean, mobile-install, info, print_action, config, cquery và aquery
- coverage kế thừa từ test
2 dòng chỉ định các tuỳ chọn cho cùng một lệnh với độ cụ thể bằng nhau được phân tích cú pháp theo thứ tự xuất hiện trong tệp.
Vì quy tắc ưu tiên này không khớp với thứ tự tệp, nên quy tắc này giúp tăng khả năng đọc được nếu bạn tuân theo thứ tự ưu tiên trong các tệp rc: bắt đầu bằng các lựa chọn common ở trên cùng và kết thúc bằng các lệnh cụ thể nhất ở cuối tệp. Bằng cách này, thứ tự đọc các tuỳ chọn sẽ giống với thứ tự áp dụng các tuỳ chọn đó, trực quan hơn.

Các đối số được chỉ định trên một dòng của tệp rc có thể bao gồm các đối số không phải là tuỳ chọn, chẳng hạn như tên của mục tiêu bản dựng, v.v. Các tuỳ chọn này, giống như các tuỳ chọn được chỉ định trong cùng các tệp, có mức độ ưu tiên thấp hơn các tuỳ chọn đồng cấp trên dòng lệnh và luôn được thêm vào danh sách rõ ràng các đối số không phải tuỳ chọn.

`--config`

Ngoài các chế độ cài đặt mặc định, tệp rc có thể được dùng để nhóm các tuỳ chọn và là cách viết tắt cho các nhóm phổ biến. Bạn có thể thực hiện việc này bằng cách thêm hậu tố :name vào lệnh. Các tuỳ chọn này bị bỏ qua theo mặc định, nhưng sẽ được đưa vào khi tuỳ chọn --config=name xuất hiện, ở trên dòng lệnh hoặc trong tệp .bazelrc, theo quy tắc đệ quy, ngay cả bên trong một định nghĩa cấu hình khác. Các tuỳ chọn do command:name chỉ định sẽ chỉ được mở rộng cho các lệnh hiện hành, theo thứ tự ưu tiên mô tả ở trên.

--config=foo mở rộng thành các tuỳ chọn được xác định trong tệp rc "tại chỗ" để các tuỳ chọn được chỉ định cho cấu hình có cùng mức độ ưu tiên với tuỳ chọn --config=foo.

Cú pháp này không mở rộng để sử dụng startup để đặt các tuỳ chọn khởi động. Chế độ cài đặt startup:config-name --some_startup_option trong miền .bazelrc sẽ bị bỏ qua.

`--enable_platform_specific_config`

Các cấu hình cụ thể của nền tảng trong .bazelrc có thể được bật tự động bằng --enable_platform_specific_config. Ví dụ: nếu hệ điều hành máy chủ là Linux và lệnh build đang chạy, thì cấu hình build:linux sẽ tự động được bật. Các giá trị nhận dạng hệ điều hành được hỗ trợ: linux, macos, windows, freebsd và openbsd. Việc bật cờ này tương đương với việc sử dụng --config=linux trên Linux, --config=windows trên Windows, v.v.

Hãy xem --enable_platform_specific_config.

Ví dụ:

Dưới đây là tệp ~/.bazelrc mẫu:

# Bob's Bazel option defaults

startup --host_jvm_args=-XX:-UseParallelGC
import /home/bobs_project/bazelrc
build --show_timestamps --keep_going --jobs 600
build --color=yes
query --keep_going

# Definition of --config=memcheck
build:memcheck --strip=never --test_timeout=3600

Các tệp khác chi phối hành vi của Bazel

`.bazelignore`

Bạn có thể chỉ định các thư mục trong không gian làm việc mà bạn muốn Bazel bỏ qua, chẳng hạn như các dự án có liên quan sử dụng các hệ thống xây dựng khác. Đặt một tệp có tên là .bazelignore ở gốc không gian làm việc rồi thêm các thư mục mà bạn muốn Bazel bỏ qua, mỗi thư mục một dòng. Các mục nhập liên quan đến thư mục gốc của không gian làm việc.

Tệp bazelrc toàn cục

Bazel đọc các tệp bazelrc không bắt buộc theo thứ tự sau:

Tệp RC hệ thống nằm tại etc/bazel.bazelrc.
Tệp rc của Workspace nằm tại $workspace/tools/bazel.rc.
Tệp RC-của trang chủ đặt tại $HOME/.bazelrc

Mỗi tệp bazelrc liệt kê ở đây đều có một cờ tương ứng để tắt chúng (ví dụ: --nosystem_rc, --noworkspace_rc, --nohome_rc). Bạn cũng có thể yêu cầu Bazel bỏ qua tất cả các bazelrcs bằng cách truyền tuỳ chọn khởi động --ignore_all_rc_files.