summaryrefslogtreecommitdiffstats
path: root/node-admin
diff options
context:
space:
mode:
authorHarald Musum <musum@verizonmedia.com>2019-05-20 21:35:57 +0200
committerHarald Musum <musum@verizonmedia.com>2019-05-20 21:35:57 +0200
commitc1f24bc229c09ab67012d8e7327e9f49780f9573 (patch)
tree45c4e1eea523180fb55ad0a389b797c7950eff98 /node-admin
parenta63726b6d2b00b16cd20ebac0bcf401fb51bfc45 (diff)
Add javadoc and improve some javadoc
Diffstat (limited to 'node-admin')
-rw-r--r--node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeagent/ContainerData.java4
-rw-r--r--node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/task/util/file/UnixPath.java5
2 files changed, 7 insertions, 2 deletions
diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeagent/ContainerData.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeagent/ContainerData.java
index 8131691affa..2e7b764df0b 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeagent/ContainerData.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeagent/ContainerData.java
@@ -28,8 +28,8 @@ public interface ContainerData {
* Symlink to a file in container at path.
*
* @param symlink The path to the symlink inside the container, absolute or relative root /.
- * @param pathInContainer The path to the file inside the container, absolute or relative root /.
+ * @param target The path to the target file for the symbolic link inside the container, absolute or relative root /.
*/
- default void createSymlink(Path symlink, Path pathInContainer) { /* TODO: Remove this when implementing classes have been updated */ }
+ default void createSymlink(Path symlink, Path target) { /* TODO: Remove this when implementing classes have been updated */ }
}
diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/task/util/file/UnixPath.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/task/util/file/UnixPath.java
index 98944e32d8b..1d0299ae272 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/task/util/file/UnixPath.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/task/util/file/UnixPath.java
@@ -207,6 +207,11 @@ public class UnixPath {
}
}
+ /**
+ * Creates a symbolic link from {@code link} to {@code this} (the target)
+ * @param link the path for the symbolic link
+ * @return the path to the symbolic link
+ */
public UnixPath createSymbolicLink(Path link) {
uncheck(() -> Files.createSymbolicLink(link, path));
return new UnixPath(link);