Trang này đề cập đến các yêu cầu và bố cục cho các thư mục đầu ra.
Yêu cầu
Các yêu cầu đối với bố cục thư mục đầu ra:
- Không xung đột nếu nhiều người dùng đang xây dựng trên cùng một hộp.
- Hỗ trợ xây dựng trong nhiều không gian làm việc cùng lúc.
- Hỗ trợ tạo nhiều cấu hình mục tiêu trong cùng một không gian làm việc.
- Không va chạm với bất kỳ công cụ nào khác.
- Dễ truy cập.
- Dễ làm sạch, thậm chí là có thể chọn lọc.
- Không rõ ràng, ngay cả khi người dùng dựa vào đường liên kết tượng trưng khi thay đổi vào thư mục ứng dụng.
- Tất cả trạng thái bản dựng cho mỗi người dùng phải nằm trong một thư mục ("Tôi muốn dọn dẹp mọi tệp .o khỏi tất cả các ứng dụng khách của mình".)
Bố cục hiện tại
Giải pháp hiện đã được triển khai:
- Bazel phải được gọi từ một thư mục chứa tệp ranh giới kho lưu trữ hoặc thư mục con của tệp đó. Nói cách khác, bạn phải gọi Bazel từ bên trong một kho lưu trữ. Nếu không, lỗi sẽ được báo cáo.
- Thư mục outputRoot mặc định là
${XDG_CACHE_HOME}/bazel(hoặc~/.cache/bazelnếu biến môi trườngXDG_CACHE_HOMEchưa được đặt) trên Linux,/private/var/tmptrên macOS và trên Windows, thư mục mặc định là%HOME%nếu được đặt, nếu không thì%USERPROFILE%nếu được đặt, nếu không thì kết quả gọiSHGetKnownFolderPath()với cờFOLDERID_Profileđược đặt. Nếu bạn đặt biến môi trường$TEST_TMPDIR, như trong phép kiểm thử của chính Bazel, thì giá trị đó sẽ ghi đè giá trị mặc định. - Trạng thái bản dựng của người dùng Bazel nằm bên dưới
outputRoot/_bazel_$USER. Thư mục này được gọi là thư mục outputUserRoot. - Bên dưới thư mục
outputUserRootcó thư mụcinstallvà thư mục đó làinstallBasecó tên là hàm băm MD5 của tệp kê khai cài đặt Bazel. - Bên dưới thư mục
outputUserRoot, thư mụcoutputBasecũng được tạo có tên là hàm băm MD5 của tên đường dẫn của thư mục gốc không gian làm việc. Ví dụ: nếu Bazel đang chạy trong thư mục gốc của không gian làm việc/home/user/src/my-project(hoặc trong một thư mục liên kết tượng trưng với thư mục đó), thì thư mục cơ sở đầu ra sẽ được tạo có tên là:/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. Bạn cũng có thể chạyecho -n $(pwd) | md5sumtrong thư mục gốc của không gian làm việc để tải MD5. - Bạn có thể sử dụng tuỳ chọn khởi động
--output_basecủa Bazel để ghi đè thư mục cơ sở đầu ra mặc định. Ví dụ:bazel --output_base=/tmp/bazel/output build x/y:z. - Bạn cũng có thể dùng tuỳ chọn khởi động
--output_user_rootcủa Bazel để ghi đè các thư mục cơ sở cài đặt và cơ sở đầu ra mặc định. Ví dụ:bazel --output_user_root=/tmp/bazel build x/y:z.
Các đường liên kết tượng trưng dành cho "bazel-<workspace-name>", "bazel-out", "bazel-testlogs" và "bazel-bin" được đặt vào thư mục không gian làm việc; các đường liên kết tượng trưng này trỏ đến một số thư mục bên trong một thư mục dành riêng cho mục tiêu bên trong thư mục đầu ra. Các đường liên kết tượng trưng này chỉ để thuận tiện cho người dùng, vì bản thân Bazel không sử dụng các đường liên kết đó. Ngoài ra, thao tác này chỉ được thực hiện nếu gốc không gian làm việc có thể ghi.
Sơ đồ bố cục
Các thư mục được bố trí như sau:
<workspace-name>/ <== The workspace root
bazel-my-project => <..._main> <== Symlink to execRoot
bazel-out => <...bazel-out> <== Convenience symlink to outputPath
bazel-bin => <...bin> <== Convenience symlink to most recent written bin dir $(BINDIR)
bazel-testlogs => <...testlogs> <== Convenience symlink to the test logs directory
/home/user/.cache/bazel/ <== Root for all Bazel output on a machine: outputRoot
_bazel_$USER/ <== Top level directory for a given user depends on the user name:
outputUserRoot
install/
fba9a2c87ee9589d72889caf082f1029/ <== Hash of the Bazel install manifest: installBase
_embedded_binaries/ <== Contains binaries and scripts unpacked from the data section of
the bazel executable on first run (such as helper scripts and the
main Java file BazelServer_deploy.jar)
7ffd56a6e4cb724ea575aba15733d113/ <== Hash of the client's workspace root (such as
/home/user/src/my-project): outputBase
action_cache/ <== Action cache directory hierarchy
This contains the persistent record of the file
metadata (timestamps, and perhaps eventually also MD5
sums) used by the FilesystemValueChecker.
command.log <== A copy of the stdout/stderr output from the most
recent bazel command.
external/ <== The directory that remote repositories are
downloaded/symlinked into.
server/ <== The Bazel server puts all server-related files (such
as socket file, logs, etc) here.
jvm.out <== The debugging output for the server.
execroot/ <== The working directory for all actions. For special
cases such as sandboxing and remote execution, the
actions run in a directory that mimics execroot.
Implementation details, such as where the directories
are created, are intentionally hidden from the action.
Every action can access its inputs and outputs relative
to the execroot directory.
_main/ <== Working tree for the Bazel build & root of symlink forest: execRoot
_bin/ <== Helper tools are linked from or copied to here.
bazel-out/ <== All actual output of the build is under here: outputPath
_tmp/actions/ <== Action output directory. This contains a file with the
stdout/stderr for every action from the most recent
bazel run that produced output.
local_linux-fastbuild/ <== one subdirectory per unique target BuildConfiguration instance;
this is currently encoded
bin/ <== Bazel outputs binaries for target configuration here: $(BINDIR)
foo/bar/_objs/baz/ <== Object files for a cc_* rule named //foo/bar:baz
foo/bar/baz1.o <== Object files from source //foo/bar:baz1.cc
other_package/other.o <== Object files from source //other_package:other.cc
foo/bar/baz <== foo/bar/baz might be the artifact generated by a cc_binary named
//foo/bar:baz
foo/bar/baz.runfiles/ <== The runfiles symlink farm for the //foo/bar:baz executable.
MANIFEST
_main/
...
genfiles/ <== Bazel puts generated source for the target configuration here:
$(GENDIR)
foo/bar.h such as foo/bar.h might be a headerfile generated by //foo:bargen
testlogs/ <== Bazel internal test runner puts test log files here
foo/bartest.log such as foo/bar.log might be an output of the //foo:bartest test with
foo/bartest.status foo/bartest.status containing exit status of the test (such as
PASSED or FAILED (Exit 1), etc)
include/ <== a tree with include symlinks, generated as needed. The
bazel-include symlinks point to here. This is used for
linkstamp stuff, etc.
host/ <== BuildConfiguration for build host (user's workstation), for
building prerequisite tools, that will be used in later stages
of the build (ex: Protocol Compiler)
<packages>/ <== Packages referenced in the build appear as if under a regular workspace
Bố cục của các thư mục *.runfiles được ghi lại chi tiết hơn ở những vị trí mà RunfilesSupport trỏ đến.
bazel clean
bazel clean thực hiện rm -rf trên outputPath và thư mục action_cache. Thao tác này cũng sẽ xoá các đường liên kết tượng trưng của không gian làm việc. Tuỳ chọn --expunge
sẽ xoá toàn bộ outputBase.