Updates docs to clarify relative path evaluation for workdir (#3269)

* Updates docs to clarify relative path evaluation for workdir * more notes --------- Co-authored-by: Romil Bhardwaj <[email protected]>
skypilot-org · Mar 4, 2024 · 14080a0 · 14080a0
1 parent 9d5232b
commit 14080a0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/source/examples/syncing-code-artifacts.rst b/docs/source/examples/syncing-code-artifacts.rst
@@ -105,6 +105,12 @@ pass the ``--no-setup`` flag to ``sky launch``. For example, ``sky launch --no-s
     under a local file_mount source are also ignored (the same behavior as
     handling ``workdir``).
 
+.. note::
+
+    If relative paths are used in :code:`file_mounts` or :code:`workdir`, they
+    are evaluated relative to the location from which the :code:`sky` command
+    is run.
+
 .. _uploading-or-reusing-large-files:
 
 Uploading or reusing large files

diff --git a/docs/source/reference/yaml-spec.rst b/docs/source/reference/yaml-spec.rst
@@ -19,6 +19,9 @@ Available fields:
     #
     # Commands in "setup" and "run" will be executed under it.
     #
+    # If a relative path is used, it's evaluated relative to the location from 
+    # which `sky` is called.
+    #
     # If a .gitignore file (or a .git/info/exclude file) exists in the working
     # directory, files and directories listed in it will be excluded from syncing.
     workdir: ~/my-task-code
@@ -252,6 +255,9 @@ Available fields:
     file_mounts:
       # Uses rsync to sync local files/directories to all nodes of the cluster.
       #
+      # If a relative path is used, it's evaluated relative to the location from
+      # which `sky` is called.
+      #
       # If symlinks are present, they are copied as symlinks, and their targets
       # must also be synced using file_mounts to ensure correctness.
       /remote/dir1/file: /local/dir1/file