12183: Tweak documenation for clarity.

[arvados.git] / doc / _includes / _mount_types.liquid

diff --git a/doc/_includes/_mount_types.liquid b/doc/_includes/_mount_types.liquid
index f47de59bf7a7b104bfb2494a4aaa24db52c639d5..4b0508db5cc6d3b80fedef8a69f11f2306fb6c81 100644 (file)
--- a/doc/_includes/_mount_types.liquid
+++ b/doc/_includes/_mount_types.liquid
@@ -1,4 +1,10 @@
-Mount types
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+h2. Mount types
 
 The "mounts" hash is the primary mechanism for adding data to the container at runtime (beyond what is already in the container image).
 
@@ -116,3 +122,7 @@ table(table table-bordered table-condensed).
 "output_path": "/tmp"
 </code></pre>|Specified path refers to the file *hello.txt* in the *alice* subdirectory|./*foo* 030326... 0:13:*bar*\n
 *Note:* Here the subdirectory *alice* is replaced with *foo* and the filename *hello.txt* from this subdirectory is replaced with *bar*.|
+
+h2(#symlinks-in-output). Symlinks in output
+
+When a container's output_path is a tmp mount backed by local disk, this output directory can contain symlinks to other files in the the output directory, or to collection mount points.  If the symlink leads to a collection mount, efficiently copy the collection into the output collection.  Symlinks leading to files or directories are expanded and created as regular files in the output collection.  Further, whether symlinks are relative or absolute, every symlink target (even targets that are symlinks themselves) must point to a path in either the output directory or a collection mount.