Çıktı Dizini Düzeni

Bu sayfada, çıkış dizinleriyle ilgili koşullar ve düzen ele alınmaktadır.

Şartlar

Çıkış dizini düzeni için şartlar:

  • Aynı kutuda birden fazla kullanıcı oluşturma işlemi yapıyorsa çakışmaz.
  • Aynı anda birden fazla çalışma alanında oluşturmayı destekler.
  • Aynı çalışma alanında birden fazla hedef yapılandırma için derlemeyi destekler.
  • Diğer araçlarla çakışmaz.
  • Kolayca erişilebilir olmalıdır.
  • Seçerek bile kolayca temizlenebilir.
  • Kullanıcı, istemci dizine geçerken sembolik bağlantılara dayansa bile net olmalıdır.
  • Kullanıcı başına tüm derleme durumu tek bir dizinin altında olmalıdır ("Tüm istemcilerimdeki tüm .o dosyalarını temizlemek istiyorum.")

Geçerli düzen

Şu anda uygulanan çözüm:

  • Bazel, depo sınırı dosyası veya bu dosyanın alt dizini içeren bir dizinden çağrılmalıdır. Başka bir deyişle, Bazel bir depo içinden çağrılmalıdır. Aksi takdirde hata bildirilir.
  • outputRoot dizini, Linux'ta varsayılan olarak ${XDG_CACHE_HOME}/bazel (veya XDG_CACHE_HOME ortam değişkeni ayarlanmadıysa ~/.cache/bazel), macOS'te /private/var/tmp, Windows'da ise varsayılan olarak %HOME%, ayarlanırsa %USERPROFILE% değerine; aksi takdirde FOLDERID_Profile işareti ayarlanmış haldeSHGetKnownFolderPath() çağrısının sonucuna ulaşır. Bazel'in kendisiyle ilgili bir testte olduğu gibi $TEST_TMPDIR ortam değişkeni ayarlanmışsa bu değer varsayılan değeri geçersiz kılar.
  • Bazel kullanıcısının derleme durumu outputRoot/_bazel_$USER altında yer alır. Buna outputUserRoot dizini denir.
  • outputUserRoot dizininin altında bir install dizini ve içinde Bazel yükleme manifestinin MD5 karması olan bir installBase dizini bulunur.
  • outputUserRoot dizininin altında, adı çalışma alanı kökünün yol adının MD5 karması olan bir outputBase dizini oluşturulur. Örneğin, Bazel Workspace kökünde /home/user/src/my-project (veya bu dizinle simge bağlantısı oluşturulmuş bir dizinde) çalışıyorsa şu adında bir çıkış ana dizini oluşturulur: /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. MD5'i almak için çalışma alanı kök dizininde echo -n $(pwd) | md5sum komutunu da çalıştırabilirsiniz.
  • Varsayılan çıkış temel dizinini geçersiz kılmak için Bazel'ın --output_base başlatma seçeneğini kullanabilirsiniz. Örneğin, bazel --output_base=/tmp/bazel/output build x/y:z.
  • Varsayılan yükleme tabanı ve çıkış temel dizinlerini geçersiz kılmak için Bazel'in --output_user_root başlatma seçeneğini de kullanabilirsiniz. Örneğin: bazel --output_user_root=/tmp/bazel build x/y:z.

"bazel-<workspace-name>", "bazel-out", "bazel-testlogs" ve "bazel-bin" sembolleri çalışma alanı dizinine yerleştirilir. Bu sembolik bağlantılar, çıkış dizinindeki hedefe özel bir dizin içindeki bazı dizinleri işaret eder. Bu sembolik bağlantılar, Bazel'in kendisi tarafından kullanılmadığı için yalnızca kullanıcıya kolaylık sağlar. Ayrıca bu işlem yalnızca çalışma alanı kökü yazılabilir ise yapılır.

Düzen şeması

Dizinler aşağıdaki gibi düzenlenir:

<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

*.runfiles dizinlerinin düzeni, RunfilesSupport tarafından işaretlenen yerlerde daha ayrıntılı olarak belgelenmiştir.

bazel clean

bazel clean, outputPath ve action_cache dizininde bir rm -rf işlemi yapar. Çalışma alanı sembolik bağlantılarını da kaldırır. --expunge seçeneği, exitBase öğesinin tamamını temizler.