Skip to content

Commit

Permalink
Note the existence of a execroot/ directory
Browse files Browse the repository at this point in the history 
To be true to the layout on disk, one should note the literal directory named `execroot` under the outputBase.

Also fix the indentation on `<workspace-name>/` due to the HTML escapes.

Closes #3520.

PiperOrigin-RevId: 167123497
  • Loading branch information
@vladmos
Alex Vandiver authored and vladmos committed Aug 31, 2017
1 parent e9e35aa commit 2fec2c7
Showing 1 changed file with 40 additions and 33 deletions.
73 changes: 40 additions & 33 deletions site/docs/output_directories.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,52 +77,59 @@ The directories are laid out as follows:
7ffd56a6e4cb724ea575aba15733d113/ <== Hash of the client's workspace directory (e.g.
/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.
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.
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.
&lt;workspace-name&gt;/ <== 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;
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.
&lt;workspace-name&gt;/ <== 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
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
&lt;workspace-name&gt;/
...
genfiles/ <== Bazel puts generated source for the target configuration here:
foo/bar/baz.runfiles/ <== The runfiles symlink farm for the //foo/bar:baz executable.
MANIFEST
&lt;workspace-name&gt;/
...
genfiles/ <== Bazel puts generated source for the target configuration here:
$(GENDIR)
foo/bar.h e.g. foo/bar.h might be a headerfile generated by //foo:bargen
testlogs/ <== Bazel internal test runner puts test log files here
foo/bartest.log e.g. 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 (e.g.
foo/bar.h e.g. foo/bar.h might be a headerfile generated by //foo:bargen
testlogs/ <== Bazel internal test runner puts test log files here
foo/bartest.log e.g. 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 (e.g.
PASSED or FAILED (Exit 1), etc)
include/ <== a tree with include symlinks, generated as needed. The
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
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)
&lt;packages&gt;/ <== Packages referenced in the build appear as if under a regular workspace
</pre>

The layout of the *.runfiles directories is documented in more detail in the places pointed to by RunfilesSupport.
The layout of the \*.runfiles directories is documented in more detail in the places pointed to by RunfilesSupport.

## `bazel clean`

Expand Down

0 comments on commit 2fec2c7

Please sign in to comment.