12183: Add comment about purpose of "relocated"

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>

diff --git a/services/crunch-run/crunchrun.go b/services/crunch-run/crunchrun.go
index bd58201749768fd86fe45328e8b20e907672bb66..0f687142a20b2487fc1a0e490c6d68c8aaba130c 100644 (file)
--- a/services/crunch-run/crunchrun.go
+++ b/services/crunch-run/crunchrun.go
@@ -940,6 +940,9 @@ func (runner *ContainerRunner) UploadOutputFile(
                return "", infoerr
        }
 
+       // When following symlinks, the source path may need to be logically
+       // relocated to some other path within the output collection.  Remove
+       // the relocateFrom prefix and replace it with relocateTo.
        relocated := relocateTo + path[len(relocateFrom):]
 
        if info.Mode().IsRegular() {