หน้านี้จะครอบคลุมข้อกำหนดและรูปแบบสำหรับไดเรกทอรีเอาต์พุต
ข้อกำหนด
ข้อกำหนดสำหรับเลย์เอาต์ไดเรกทอรีเอาต์พุตมีดังนี้
- ไม่ทับซ้อนกันหากผู้ใช้หลายคนกำลังสร้างในกล่องเดียวกัน
- รองรับการสร้างในหลายเวิร์กスペースพร้อมกัน
- รองรับการสร้างการกำหนดค่าเป้าหมายหลายรายการในพื้นที่ทํางานเดียวกัน
- ไม่ทับซ้อนกับเครื่องมืออื่นๆ
- เข้าถึงได้ง่าย
- ทำความสะอาดได้ง่าย แม้จะเป็นแบบเลือกทำความสะอาด
- ชัดเจน แม้ว่าผู้ใช้จะใช้ลิงก์สัญลักษณ์เมื่อเปลี่ยนเป็นไดเรกทอรีไคลเอ็นต์
- สถานะการสร้างทั้งหมดต่อผู้ใช้ควรอยู่ภายใต้ไดเรกทอรีเดียว ("ฉันต้องการล้างไฟล์ .o ทั้งหมดจากลูกค้าทั้งหมด")
เลย์เอาต์ปัจจุบัน
โซลูชันที่ใช้งานอยู่ในปัจจุบัน
- คุณต้องเรียกใช้ Bazel จากไดเรกทอรีที่มีไฟล์ขอบเขตของ repo หรือไดเรกทอรีย่อยของไดเรกทอรีนั้น กล่าวคือ ต้องเรียกใช้ Bazel จากภายในที่เก็บข้อมูล มิฉะนั้น ระบบจะรายงานข้อผิดพลาด
- ไดเรกทอรี outputRoot จะมีค่าเริ่มต้นเป็น
${XDG_CACHE_HOME}/bazel(หรือ~/.cache/bazelหากไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อมXDG_CACHE_HOME) ใน Linux,/private/var/tmpใน macOS และใน Windows จะมีค่าเริ่มต้นเป็น%HOME%หากตั้งค่าไว้ ไม่เช่นนั้นจะเป็น%USERPROFILE%หากตั้งค่าไว้ ไม่เช่นนั้นจะเป็นผลลัพธ์ของการเรียกใช้SHGetKnownFolderPath()โดยตั้งค่า FlagFOLDERID_Profileหากมีการตั้งค่าตัวแปรสภาพแวดล้อม$TEST_TMPDIRไว้ เช่นเดียวกับการทดสอบ Bazel เอง ค่าดังกล่าวจะลบล้างค่าเริ่มต้น - สถานะการสร้างของผู้ใช้ Bazel จะแสดงอยู่ใต้
outputRoot/_bazel_$USERซึ่งเรียกว่าไดเรกทอรี outputUserRoot - ใต้ไดเรกทอรี
outputUserRootจะมีไดเรกทอรีinstallและในไดเรกทอรีเป็นinstallBaseซึ่งมีชื่อเป็นแฮช MD5 ของไฟล์ Manifest การติดตั้ง Bazel - ระบบจะสร้างไดเรกทอรี
outputBaseใต้ไดเรกทอรีoutputUserRootด้วย โดยชื่อของไดเรกทอรีนี้คือแฮช MD5 ของชื่อเส้นทางรูทของพื้นที่ทำงาน ตัวอย่างเช่น หาก Bazel กำลังทำงานในรูทของพื้นที่ทำงาน/home/user/src/my-project(หรือในไดเรกทอรีที่ลิงก์กับไดเรกทอรีนั้น) ระบบจะสร้างไดเรกทอรีฐานเอาต์พุตชื่อ/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113นอกจากนี้ คุณยังเรียกใช้echo -n $(pwd) | md5sumในรูทของพื้นที่ทํางานเพื่อรับ MD5 ได้ด้วย - คุณใช้ตัวเลือกการเริ่มต้น
--output_baseของ Bazel เพื่อลบล้างไดเรกทอรีฐานเอาต์พุตเริ่มต้นได้ ตัวอย่างเช่นbazel --output_base=/tmp/bazel/output build x/y:z - คุณยังใช้ตัวเลือก
--output_user_rootสำหรับการเริ่มต้นระบบของ Bazel เพื่อลบล้างไดเรกทอรีฐานการติดตั้งและไดเรกทอรีฐานเอาต์พุตเริ่มต้นได้ด้วย ตัวอย่างเช่นbazel --output_user_root=/tmp/bazel build x/y:z
ลิงก์สัญลักษณ์สำหรับ "bazel-<workspace-name>", "bazel-out", "bazel-testlogs" และ "bazel-bin" จะปรากฏในไดเรกทอรีพื้นที่ทำงาน symlink เหล่านี้จะชี้ไปยังไดเรกทอรีบางรายการภายในไดเรกทอรีเป้าหมายภายในไดเรกทอรีเอาต์พุต ลิงก์สัญลักษณ์เหล่านี้มีไว้เพื่ออำนวยความสะดวกแก่ผู้ใช้เท่านั้น เนื่องจาก Bazel ไม่ได้ใช้ลิงก์เหล่านี้ นอกจากนี้ การดำเนินการนี้จะทำได้ก็ต่อเมื่อรูทของพื้นที่ทำงานเขียนได้เท่านั้น
แผนภาพเลย์เอาต์
ไดเรกทอรีจะมีรูปแบบดังนี้
<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
เลย์เอาต์ของไดเรกทอรี *.runfiles มีรายละเอียดเพิ่มเติมในตำแหน่งที่ RunfilesSupport ชี้ไป
bazel clean
bazel clean ทำการrm -rfใน outputPath และไดเรกทอรี action_cache
รวมถึงนำลิงก์สัญลักษณ์ของพื้นที่ทำงานออกด้วย ตัวเลือก --expunge จะล้าง outputBase ทั้งหมด