From 3136d9c26a01cb68890af0e09020ce1d5881d7a1 Mon Sep 17 00:00:00 2001
From: Googler <gregce@google.com>
Date: Thu, 12 Jan 2023 12:05:48 -0800
Subject: [PATCH] Document concepts like root, exec root, exec path more
 clearly.

PiperOrigin-RevId: 501630570
Change-Id: I16a8d7e46582f5c7cf5107a205613d07bdaaaf79
---
 .../devtools/build/lib/actions/Artifact.java  |  6 ++-
 .../build/lib/actions/ArtifactRoot.java       | 48 ++++++++++++++++++-
 2 files changed, 50 insertions(+), 4 deletions(-)

diff --git a/src/main/java/com/google/devtools/build/lib/actions/Artifact.java b/src/main/java/com/google/devtools/build/lib/actions/Artifact.java
index 206019dc275a18..6a440843f7cfa9 100644
--- a/src/main/java/com/google/devtools/build/lib/actions/Artifact.java
+++ b/src/main/java/com/google/devtools/build/lib/actions/Artifact.java
@@ -87,8 +87,10 @@
  *       validation, will also have null generating Actions.
  * </ul>
  *
- * In the usual case, an Artifact represents a single file. However, an Artifact may also represent
- * the following:
+ * <p>See {@link ArtifactRoot} for a detailed example on root, execRoot, and related paths.
+ *
+ * <p>In the usual case, an Artifact represents a single file. However, an Artifact may also
+ * represent the following:
  *
  * <ul>
  *   <li>A TreeArtifact, which is a directory containing a tree of unknown {@link Artifact}s. In the
diff --git a/src/main/java/com/google/devtools/build/lib/actions/ArtifactRoot.java b/src/main/java/com/google/devtools/build/lib/actions/ArtifactRoot.java
index d237255fc70079..ca1a6e6e01db68 100644
--- a/src/main/java/com/google/devtools/build/lib/actions/ArtifactRoot.java
+++ b/src/main/java/com/google/devtools/build/lib/actions/ArtifactRoot.java
@@ -17,6 +17,8 @@
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Interner;
 import com.google.common.collect.Interners;
+import com.google.devtools.build.lib.actions.Artifact.DerivedArtifact;
+import com.google.devtools.build.lib.actions.Artifact.SourceArtifact;
 import com.google.devtools.build.lib.cmdline.LabelConstants;
 import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
 import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
@@ -30,7 +32,7 @@
 /**
  * A root for an artifact. The roots are the directories containing artifacts, and they are mapped
  * together into a single directory tree to form the execution environment. There are two kinds of
- * roots, source roots and derived roots. Source roots correspond to entries of the package path,
+ * roots: source roots and derived roots. Source roots correspond to entries of the package path,
  * and they can be anywhere on disk. Derived roots correspond to output directories; there are
  * generally different output directories for different configurations, and different types of
  * output (bin, genfiles, includes, etc.).
@@ -40,8 +42,50 @@
  * responsible for determining that mapping. The derived roots, on the other hand, have to be
  * distinct. (It is currently allowed to have a derived root that is the prefix of another one.)
  *
- * <p>The derived roots must have paths that point inside the exec root, i.e. below the directory
+ * <p>Derived roots must have paths that point inside the exec root ({@link
+ * com.google.devtools.build.lib.analysis.BlazeDirectories#getExecRoot}), i.e. below the directory
  * that is the root of the merged directory tree.
+ *
+ * <p>For example, if
+ *
+ * <ul>
+ *   <li>your workspace is {@code /home/my_workspace/}
+ *   <li>your package path is {@code /home/my_workspace/} (the norm unless you're customizing {@link
+ *       com.google.devtools.build.lib.pkgcache.PackageOptions#packagePath}).
+ *   <li>your workspace has a source file at {@code /home/my_workspace/myapp/source.go}
+ *   <li>you build a binary that outputs {@code /home/my_workspace/bazel-out/x86-opt/bin/a/mybinary}
+ * </ul>
+ *
+ * <p>then
+ *
+ * <ul>
+ *   <li>Bazel creates an "output base" directory {@code $OUTPUT_BASE} which it uses for staging
+ *       build work: {@link com.google.devtools.build.lib.analysis.BlazeDirectories#getOutputBase()}
+ *   <li>Bazel creates an exec root at {@code $OUTPUT_BASE/execroot/my_workspace/}. This symlinks
+ *       all files and directories under {@code /home/my_workspace/}. This is the working directory
+ *       where actions run (either directly for local execution or as the base for staging remote
+ *       execution paths). This is also the base directory for writing outputs.
+ *   <li>{@code /home/my_workspace/myapp/source.go} is a {@link SourceArtifact} with source root
+ *       {@code /home/my_workspace/}
+ *   <li>{@code /home/my_workspace/bazel-out/x86-opt/bin/a/mybinary} is a {@link DerivedArtifact}.
+ *       Because derived artifacts are written under the exec root, {@code
+ *       /home/my_workspace/bazel-out} is a symlink to {@code $EXEC_ROOT/bazel-out}. So {@code
+ *       mybinary} is actually at {@code $EXEC_ROOT/bazel-out/x86-opt/bin/mybinary}. Its derived
+ *       root is therefore {@code $EXEC_ROOT/bazel-out/x86-opt/bin/}.
+ * </ul>
+ *
+ * <p>The "exec path" ({@link Artifact#getExecPath()}, {@link #getExecPath()}, etc.) is an entity's
+ * path relative to the exec root. So {@code /home/my_workspace/myapp/source.go}'s exec path is
+ * {@code myapp/source.go} and {@code /home/my_workspace/bazel-out/x86-opt/bin/a/mybinary}'s exec
+ * path is {@code bazel-out/x86-opt/bin/a/mybinary}
+ *
+ * <p>The "root-relative path" ({@link Artifact#getRootRelativePath()}) is a entity's path relative
+ * to its root. So {@code /home/my_workspace/myapp/source.go}'s root-relative path is {@code
+ * myapp/source.go} and {@code /home/my_workspace/bazel-out/x86-opt/bin/a/mybinary}'s root-relative
+ * path is {@code a/mybinary}.
+ *
+ * <p>For concrete examples, run {@code $ bazel info} in your terminal after a build. Also see <a
+ * href="https://bazel.build/remote/output-directories">Bazel's output directory docs</a>.
  */
 @AutoCodec
 @Immutable