Halaman ini membahas persyaratan dan tata letak untuk direktori output.
Persyaratan
Persyaratan untuk tata letak direktori output:
- Tidak bertabrakan jika beberapa pengguna membuat aplikasi di kotak yang sama.
- Mendukung pembangunan di beberapa ruang kerja secara bersamaan.
- Mendukung build untuk beberapa konfigurasi target di ruang kerja yang sama.
- Tidak bertabrakan dengan alat lain.
- Mudah diakses.
- Mudah dibersihkan, bahkan secara selektif.
- Tidak ambigu, bahkan jika pengguna mengandalkan tautan simbolis saat beralih ke direktori klien.
- Semua status build per pengguna harus di bawah satu direktori ("saya ingin membersihkan semua file {i> .o<i} dari semua klien saya.")
Tata letak saat ini
Solusi yang saat ini diterapkan:
- Bazel harus dipanggil dari direktori yang berisi file WORKSPACE ( "direktori ruang kerja"), atau subdirektorinya. IDS melaporkan {i> error<i} jika tidak.
- Direktori outputRoot secara default ditetapkan ke
~/.cache/bazeldi Linux,/private/var/tmpdi macOS, dan di Windows, default-nya adalah%HOME%jika disetel, else%USERPROFILE%jika disetel, atau hasil dari panggilanSHGetKnownFolderPath()dengan flagFOLDERID_Profileyang disetel. Jika variabel lingkungan$TEST_TMPDIRdiatur, seperti dalam pengujian Bazel sendiri, maka nilai itu akan menggantikan nilai {i>default<i}. - Status build pengguna Bazel terletak di bawah
outputRoot/_bazel_$USER. Ini disebut direktori outputUserRoot. - Di bawah direktori
outputUserRootada direktoriinstall, dan di ini adalah direktoriinstallBaseyang namanya adalah hash MD5 dari Bazel manifes penginstalan. - Di bawah direktori
outputUserRoot, direktorioutputBasejuga dibuat dengan nama hash MD5 dari nama jalur ruang kerja saat ini. Jadi, misalnya, jika Bazel berjalan di direktori workspace/home/user/src/my-project(atau dalam direktori yang di-symlink ke instance tersebut), lalu direktori basis output yang dibuat bernama:/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. - Anda dapat menggunakan opsi memulai
--output_baseBazel untuk mengganti setelan default direktori basis output. Misalnya,bazel --output_base=/tmp/bazel/output build x/y:z. - Anda juga dapat menggunakan opsi memulai
--output_user_rootBazel untuk mengganti direktori basis instalan{i> default <i} dan basis {i>output<i}. Contoh:bazel --output_user_root=/tmp/bazel build x/y:z.
Symlink untuk "bazel-<workspace-name>", "bazel-out", "bazel-testlogs", dan "bazel-bin" ditempatkan di direktori {i>workspace<i}; {i>symlink<i} ini menunjuk ke beberapa direktori di dalam direktori khusus target di dalam direktori {i>output<i}. {i>symlink<i} ini hanya untuk kenyamanan pengguna, karena Bazel sendiri tidak menggunakannya. Juga, ini hanya dilakukan jika direktori ruang kerja dapat ditulis.
Diagram tata letak
Direktori tersebut ditata sebagai berikut:
<workspace-name>/ <== The workspace directory
bazel-my-project => <...my-project> <== Symlink to execRoot
bazel-out => <...bin> <== 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 directory (such as
/home/some-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.
action_outs/ <== Action output directory. This contains a file with the
stdout/stderr for every action from the most recent
bazel run that produced output.
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.
All actions can access its inputs and outputs relative
to the execroot directory.
<workspace-name>/ <== 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
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
<workspace-name>/
...
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
Tata letak direktori *.runfiles didokumentasikan secara lebih mendetail di tempat yang ditunjuk oleh RunfilesSupport.
bazel clean
bazel clean melakukan rm -rf di outputPath dan action_cache
saat ini. Tindakan ini juga akan menghapus symlink ruang kerja. Opsi --expunge
akan membersihkan seluruh outputBase.