aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java
diff options
context:
space:
mode:
authorGravatar laurentlb <laurentlb@google.com>2018-02-12 03:29:13 -0800
committerGravatar Copybara-Service <copybara-piper@google.com>2018-02-12 03:30:34 -0800
commit523253189d379fda74cea3618c1bace284c5f0fa (patch)
treef4ed320a08d9905971b9159873989792bd926e01 /src/main/java
parentafbab998b5ae2f37c4d7999260a102d92ea6cda1 (diff)
Update documentation about Files.
I don't think it's worth repeating things here. Let's point to the main documentation. RELNOTES: None. PiperOrigin-RevId: 185356504
Diffstat (limited to 'src/main/java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/actions/Artifact.java13
1 files changed, 4 insertions, 9 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 964b05d5a6..4f6ac30365 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
@@ -109,15 +109,10 @@ import javax.annotation.Nullable;
"<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. If you have a Skylark rule that needs to create a new File, "
- + "you have two options:"
- + "<ul>"
- + "<li>use <a href='actions.html#declare_file'>ctx.actions.declare_file</a> "
- + "or <a href='actions.html#declare_directory'>ctx.actions.declare_directory</a> to "
- + "declare a new file in the rule implementation.</li>"
- + "<li>add the label to the attrs (if it's an input) or the outputs (if it's an output)."
- + " Then you can access the File through the rule's "
- + "<a href='ctx.html#outputs'>ctx.outputs</a>."
+ + "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>."
)
@AutoCodec(dependency = FileSystemProvider.class)
public class Artifact