cmd ref: small pending improvements from recent import/update changes

per #1007 (review)
iterative · Apr 7, 2020 · f8789da · f8789da
1 parent 030dfc5
commit f8789da
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 14 deletions.
diff --git a/content/docs/command-reference/import.md b/content/docs/command-reference/import.md
@@ -84,9 +84,9 @@ data artifact from the source repo.
   download the file or directory from. The latest commit in `master` (tip of the
   default branch) is used by default when this option is not specified.
 
-  > Note that this adds a `rev` field in the import stage that fixes it to this
-  > revision. This can impact the behavior of `dvc update`. (See
-  > **re-importing** example below.)
+  > Note that this adds a `rev` field in the import stage that fixes it to the
+  > revision. This can impact the behavior of `dvc update`. (See the **Importing
+  > and updating fixed revisions** example below.)
 
 - `-h`, `--help` - prints the usage/help message, and exit.
 
@@ -173,6 +173,9 @@ different commit with `dvc update --rev`:
 $ dvc update --rev cats-dogs-v2
 ```
 
+> In the above example, the value for `rev` in the new import stage will be
+> `master` (a branch) so it will be able update normally going forward.
+
 ## Example: Data registry
 
 If you take a look at our

diff --git a/content/docs/command-reference/update.md b/content/docs/command-reference/update.md
@@ -36,14 +36,13 @@ dvc update --rev master
 
 ## Options
 
-- `--rev` - specific
-  [Git revision](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
-  (such as a branch name, a tag, or a commit hash) of the repository to update
-  the file or directory from (also starts tracking the given revision).
+- `--rev` - commit hash, branch or tag name, etc. (any
+  [Git revision](https://git-scm.com/docs/revisions)) of the repository to
+  update the file or directory from. The latest commit in `master` (tip of the
+  default branch) is used by default when this option is not specified.
 
-  > Note that this adds or updates a `rev` field in the DVC-file that fixes it
-  > to this revision (and updates `rev_lock` in the DVC-file). This can have an
-  > impact on the behavior of `dvc update` later.
+  > Note that this changes the `rev` field in the import stage, fixing it to the
+  > revision.
 
 - `-h`, `--help` - prints the usage/help message, and exit.
 
@@ -82,15 +81,19 @@ stable.
 > [DVC-file](/doc/user-guide/dvc-file-format) (when there are changes to bring
 > in).
 
-## Example: Updating imported artifacts to a specified revision
+## Example: Updating fixed-revision imports to a different version
 
-Let's import a model from an older version of our
+> See also
+> [Importing and updating fixed revisions](/doc/command-reference/import#example-importing-and-updating-fixed-revisions).
+
+Let's import a model from a specific version of our
 [get started example repo](https://github.com/iterative/example-get-started)
 first:
 
 ```dvc
 $ dvc import --rev baseline-experiment \
-            [email protected]:iterative/example-get-started model.pkl
+            [email protected]:iterative/example-get-started \
+            model.pkl
 Importing 'model.pkl ([email protected]:iterative/example-get-started)'
 -> 'model.pkl'
 ```
@@ -116,4 +119,4 @@ Importing 'model.pkl ([email protected]:iterative/example-get-started)'
 ```
 
 The import stage is overwritten, and will get updated from the latest changes in
-the given revision (i.e. `bigrams-experiment` tag).
+the given commit (tag `bigrams-experiment`).