cmd: add dvc update --to-remote docs (#2175)

* cmd: add dvc update --to-remote docs * Update content/docs/command-reference/update.md Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: Ivan Shcheklein <[email protected]> Co-authored-by: Jorge Orpinel <[email protected]>
iterative · Feb 18, 2021 · 3d7aed3 · 3d7aed3
1 parent 7d88307
commit 3d7aed3
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/content/docs/command-reference/update.md b/content/docs/command-reference/update.md
@@ -6,8 +6,8 @@ repositories</abbr>, and the corresponding import stage `.dvc` files.
 ## Synopsis
 
 ```usage
-usage: dvc update [-h] [-q | -v] [--rev <commit>] [-R]
-                  targets [targets ...]
+usage: dvc update [-h] [-q | -v] [--rev <commit>] [-R] [--to-remote]
+                  [-r <name>] [-j <number>] targets [targets ...]
 
 positional arguments:
   targets      Import stage .dvc files to update. Using -R, directories
@@ -49,6 +49,20 @@ $ dvc update --rev master
   directory and its subdirectories for import stage `.dvc` files to inspect. If
   there are no directories among the targets, this option is ignored.
 
+- `--to-remote` - update the import `.dvc` file and
+  [transfer](/doc/command-reference/import-url#example-import-straight-to-the-remote)
+  the new data directly to remote storage (the default one unless `-r` is used).
+  No changes are done in the <abbr>workspace</abbr>. Use `dvc pull` to get the
+  data locally.
+
+- `-r <name>`, `--remote <name>` - name of the
+  [remote storage](/doc/command-reference/remote) (can only be used with
+  `--to-remote`).
+
+- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
+  from the source. The default value is `4 * cpu_count()`. For SSH remotes, the
+  default is `4`. Using more jobs may speed up the operation.
+
 - `-h`, `--help` - prints the usage/help message, and exit.
 
 - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no