aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar vladmos <vladmos@google.com>2017-12-15 10:54:51 -0800
committerGravatar Copybara-Service <copybara-piper@google.com>2017-12-15 10:57:09 -0800
commit29f113dad49b19606faf885500b34ff5b2dcf624 (patch)
tree1a5b487b282104a5ea35770e4cddae9b9b41afba
parenta0112a844561680b107a7b647e31586124fb8f92 (diff)
Clarify the documentation for File.dirname
PiperOrigin-RevId: 179213789
-rw-r--r--src/main/java/com/google/devtools/build/lib/actions/Artifact.java3
1 files changed, 2 insertions, 1 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 7970ed97e3..7d1a5b79e2 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
@@ -267,7 +267,8 @@ public class Artifact
* <p> The directory name is always a relative path to the execution directory.
*/
@SkylarkCallable(name = "dirname", structField = true,
- doc = "The name of the directory containing this file.")
+ doc = "The name of the directory containing this file. It's taken from "
+ + "<a href=\"#path\">path</a> and is always relative to the execution directory.")
public final String getDirname() {
PathFragment parent = getExecPath().getParentDirectory();
return (parent == null) ? "/" : parent.getSafePathString();