इस पेज पर, आउटपुट डायरेक्ट्री के लिए ज़रूरी शर्तों और लेआउट के बारे में बताया गया है.
ज़रूरी शर्तें
आउटपुट डायरेक्ट्री के लेआउट से जुड़ी ज़रूरी शर्तें:
- अगर एक ही बॉक्स पर कई उपयोगकर्ता बना रहे हैं, तो एक-दूसरे के साथ टकराव नहीं होता.
- एक ही समय में कई वर्कस्पेस में बिल्डिंग बनाने की सुविधा.
- एक ही वर्कस्पेस में कई टारगेट कॉन्फ़िगरेशन के लिए बिल्ड करने की सुविधा.
- यह किसी दूसरे टूल के साथ काम नहीं करता.
- इसे आसानी से ऐक्सेस किया जा सकता है.
- इसे आसानी से साफ़ किया जा सकता है.
- यह साफ़ तौर पर बताता है कि क्लाइंट डायरेक्ट्री में बदलते समय, उपयोगकर्ता सिंबल लिंक का इस्तेमाल कर सकता है.
- हर उपयोगकर्ता के लिए, बिल्ड की सभी स्थितियां एक ही डायरेक्ट्री में होनी चाहिए ("मुझे अपने सभी क्लाइंट से सभी .o फ़ाइलों को हटाना है.")
मौजूदा लेआउट
फ़िलहाल लागू किया गया समाधान:
- Bazel को उस डायरेक्ट्री से शुरू किया जाना चाहिए जिसमें रिपॉज़िटरी की बाउंड्री फ़ाइल या उसकी सबडायरेक्ट्री हो. दूसरे शब्दों में, Bazel को किसी रिपॉज़िटरी से शुरू किया जाना चाहिए. ऐसा न करने पर, गड़बड़ी की शिकायत की जाती है.
- outputRoot डायरेक्ट्री, डिफ़ॉल्ट रूप से Linux पर
${XDG_CACHE_HOME}/bazel(XDG_CACHE_HOMEएनवायरमेंट वैरिएबल सेट न होने पर~/.cache/bazel) और macOS पर/private/var/tmpपर सेट होती है. वहीं, Windows पर यह डिफ़ॉल्ट रूप से%HOME%पर सेट होती है. अगर यह सेट नहीं है, तो%USERPROFILE%पर सेट होती है. इसके अलावा,FOLDERID_Profileफ़्लैग सेट करकेSHGetKnownFolderPath()को कॉल करने पर भी यह डायरेक्ट्री%HOME%पर सेट होती है. अगर एनवायरमेंट वैरिएबल$TEST_TMPDIRसेट है, जैसे कि Bazel की जांच में, तो वह वैल्यू डिफ़ॉल्ट वैल्यू को बदल देती है. - Bazel उपयोगकर्ता के बिल्ड की स्थिति,
outputRoot/_bazel_$USERके नीचे होती है. इसे outputUserRoot डायरेक्ट्री कहा जाता है. outputUserRootडायरेक्ट्री के नीचे एकinstallडायरेक्ट्री है. इसमें एकinstallBaseडायरेक्ट्री है, जिसका नाम Bazel इंस्टॉलेशन मेनिफ़ेस्ट का MD5 हैश है.outputUserRootडायरेक्ट्री के नीचे, एकoutputBaseडायरेक्ट्री भी बनाई जाती है. इसका नाम, वर्कस्पेस के रूट के पाथ के नाम का MD5 हैश होता है. उदाहरण के लिए, अगर Bazel, Workspace के रूट/home/user/src/my-project(या उससे लिंक की गई किसी डायरेक्ट्री) में चल रहा है, तो एक आउटपुट बेस डायरेक्ट्री बनाई जाती है, जिसे/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113कहा जाता है. MD5 पाने के लिए, वर्कस्पेस रूट मेंecho -n $(pwd) | md5sumभी चलाया जा सकता है.- डिफ़ॉल्ट आउटपुट बेस डायरेक्ट्री को बदलने के लिए, Bazel के
--output_baseस्टार्टअप विकल्प का इस्तेमाल किया जा सकता है. उदाहरण के लिए,bazel --output_base=/tmp/bazel/output build x/y:z. - डिफ़ॉल्ट इंस्टॉल बेस और आउटपुट बेस डायरेक्ट्री को बदलने के लिए, Bazel के
--output_user_rootस्टार्टअप विकल्प का भी इस्तेमाल किया जा सकता है. उदाहरण के लिए:bazel --output_user_root=/tmp/bazel build x/y:z.
"bazel-<workspace-name>", "bazel-out", "bazel-testlogs", और "bazel-bin" के लिए सिमलिंक, फ़ाइल फ़ोल्डर डायरेक्ट्री में डाले जाते हैं. ये सिमलिंक, आउटपुट डायरेक्ट्री में मौजूद टारगेट डायरेक्ट्री में मौजूद कुछ डायरेक्ट्री पर ले जाते हैं. ये सिमलंक सिर्फ़ उपयोगकर्ता की सुविधा के लिए होते हैं, क्योंकि Bazel खुद इनका इस्तेमाल नहीं करता. साथ ही, ऐसा सिर्फ़ तब किया जाता है, जब फ़ाइलें बनाने के लिए, फ़ाइल फ़ोल्डर के रूट का ऐक्सेस हो.
लेआउट डायग्राम
डायरेक्ट्री इस तरह से बनाई जाती हैं:
<workspace-name>/ <== The workspace root
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 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.
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.
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
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
RunfilesSupport की ओर से बताई गई जगहों पर, *.runfiles डायरेक्ट्री के लेआउट के बारे में ज़्यादा जानकारी दी गई है.
bazel clean
bazel clean, outputPath और action_cache डायरेक्ट्री पर rm -rf करता है. इससे फ़ाइल फ़ोल्डर के सिर्फ़ लिंक हट जाते हैं. --expunge विकल्प, पूरे outputBase को मिटा देगा.