aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/actions/Artifact.java
diff options
context:
space:
mode:
authorGravatar brandjon <brandjon@google.com>2018-02-26 07:20:00 -0800
committerGravatar Copybara-Service <copybara-piper@google.com>2018-02-26 07:22:00 -0800
commit4d1425910e757334d5f6c6ed9eb71916dc97fd6e (patch)
tree3c0b56783cde9c2d34ffb429767ec5a8b24cb531 /src/main/java/com/google/devtools/build/lib/actions/Artifact.java
parentaf24688e4e0c8c359a2ec7af3fffaa1c825ef7ed (diff)
Revamp rules.md documentation for files
Unified "Files" and "Output files" sections. Renamed "declared files" to "predeclared files" to avoid confusion with "declare_file()"/"declare_directory()". RELNOTES: None PiperOrigin-RevId: 187017607
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/actions/Artifact.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/actions/Artifact.java18
1 files changed, 8 insertions, 10 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 85873b27a0..918c6b998c 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
@@ -101,16 +101,14 @@ import javax.annotation.Nullable;
*/
@Immutable
@SkylarkModule(
- name = "File",
- category = SkylarkModuleCategory.BUILTIN,
- doc =
- "<p>This type represents a file or directory used by the build system. It can be "
- + "either a source file or a derived file produced by a rule.</p>"
- + "<p>The File constructor is private, so you cannot call it directly to create new "
- + "Files. You typically get a File object from a "
- + "<a href='Target.html'>Target</a>, or using "
- + "<a href='actions.html#declare_file'>ctx.actions.declare_file</a>, "
- + "or <a href='actions.html#declare_directory'>ctx.actions.declare_directory</a>."
+ name = "File",
+ category = SkylarkModuleCategory.BUILTIN,
+ doc = "This object is created during the analysis phase to represent a file or directory that "
+ + "will be read or written during the execution phase. It is not an open file handle, and "
+ + "cannot be used to directly read or write file contents. Rather, you use it to construct "
+ + "the action graph in a rule implementation function by passing it to action-creating "
+ + "functions. See the <a href='../rules.$DOC_EXT#files'>Rules page</a> for more "
+ + "information."
)
@AutoCodec
public class Artifact