Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd: update version ref. #1814

Merged
merged 19 commits into from
Oct 12, 2020
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 25 additions & 32 deletions content/docs/command-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,16 @@ usage: dvc version [-h] [-q | -v]

| Line | Detail |
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`DVC version`](#components-of-dvc-version) | Version of DVC (along with a Git commit hash if running a development version) |
| `Python version` | Version of Python used in the environment where DVC is initialized |
| `Platform` | Information about the operating system of the machine |
| [`Binary`](#what-we-mean-by-binary) | Shows whether DVC was installed from a package or from a binary release |
| `Package` | Name of the package manager used to install DVC if any (`pip`, `conda`, etc) |
| `Supported remotes` | Remote types that have all needed dependencies installed for |
| `Cache` | [Type of links](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) supported between the <abbr>workspace</abbr> and the <abbr>cache</abbr> |
| `Filesystem type` | Shows the filesystem type (eg. ext4, FAT, etc.) and mount point of the cache and <abbr>workspace</abbr> directories |
| [`DVC version`](#components-of-dvc-version) | Version of DVC (along with a Git commit hash in case of a development version) and name of the package manager (`pip`, `conda`, etc.) or binary used to install DVC |
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
| `Platform` | Version of Python in the environment where DVC is initialized, and information about the operating system |
| `Supports` | Shows remote types that have all needed dependencies installed |
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
| `Cache types` | [Type of links](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) supported (between <abbr>workspace</abbr> and <abbr>cache</abbr> |
| `Cache directory` | Shows the filesystem type (eg. ext4, FAT, etc.) and mount point of the <abbr>cache</abbr> directory |
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
| `Workspace directory` | Shows the filesystem type and mount point of the <abbr>workspace</abbr> directory |
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
| `Repo` | Shows whether we are in a DVC repo and/or Git repo |

> If `dvc version` is executed outside a DVC project, no `Cache` info is
> printed, and the `Filesystem type` output is of the current working directory.
> If `dvc version` is executed outside a DVC project, neither `Cache` nor
> `Workspace` info is printed.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

> Note that if you've installed DVC using `pip`, you will need to install
> `psutil` manually with `pip install psutil` in order for `dvc version` to
Expand All @@ -42,7 +40,7 @@ The detail of DVC version depends upon the way of installing DVC.
reported with the official build can be traced using the `_BASE_VERSION`
constant
[in our core repo](https://github.com/iterative/dvc/blob/master/dvc/version.py).
For example `0.40.2`.
For example `1.7.4`.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

> 💡 To only get this number, use `dvc -V`.

Expand All @@ -55,17 +53,15 @@ The detail of DVC version depends upon the way of installing DVC.
to publish yet. Therefore, installing with this method might result in usage
issues. To trace any error reported with this setup, we need to know exactly
which version is being used. For this we rely on a Git commit hash that is
displayed in the output of `dvc version` like this: `0.40.2+292cab.mod`. The
displayed in the output of `dvc version` like this: `1.7.2+292cab.mod`. The
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
part before `+` is the `_BASE_VERSION`, and the following part is the commit
hash of the tip of the `master` branch. The optional suffix `.mod` means that
code is modified.

### What we mean by "Binary"
- **Package manager or Binary**: This part shows how DVC was downloaded and
[installed](/doc/install).
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

The detail of `Binary` depends on the way DVC was downloaded and
[installed](/doc/install).

- **`Binary: True`** - displayed when DVC is downloaded/installed as one of:
DVC can be installed from one of the binary release:
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

- Debian package (`.deb`) - file used to install packages in several Linux
distributions, like Ubuntu
Expand All @@ -81,7 +77,7 @@ The detail of `Binary` depends on the way DVC was downloaded and
[PyInstaller](https://pythonhosted.org/PyInstaller/) to bundle our source code
into the binary package app.

- **`Binary: False`** - shown when DVC is downloaded and installed from:
DVC can also be downloaded and installed using a package manager:

- [DVC's GitHub repository](https://github.com/iterative/dvc) - where core
source code is hosted
Expand Down Expand Up @@ -113,26 +109,23 @@ Inside a DVC project:
```dvc
$ dvc version

DVC version: 0.41.3+f36162
Python version: 3.7.1
Platform: Linux-4.15.0-50-generic-x86_64-with-debian-buster-sid
Binary: False
Cache: reflink - False, hardlink - True, symlink - True
Supported remotes: azure, gdrive, gs, hdfs, http, https, s3, ssh, oss
Filesystem type (cache directory): ('ext4', '/dev/sdb3')
DVC version: 1.7.4 (pip)
---------------------------------
Platform: Python 3.8.3 on Linux-5.4.0-47-generic-x86_64-with-debian-buster-sid
Supports: All remotes
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
Cache types: hardlink, symlink
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
Cache directory: ext4 on /dev/sda1
Workspace directory: ext4 on /dev/sda1
Repo: dvc, git
Filesystem type (workspace): ('ext4', '/dev/sdb3')
```

Outside a DVC project:

```dvc
$ dvc version

DVC version: 0.41.3+f36162
Python version: 3.7.1
Platform: Linux-4.15.0-50-generic-x86_64-with-debian-buster-sid
Binary: False
Supported remotes: azure, gdrive, gs, hdfs, http, https, s3, ssh, oss
Filesystem type (workspace): ('ext4', '/dev/sdb3')
DVC version: 1.7.4 (pip)
---------------------------------
Platform: Python 3.8.3 on Linux-5.4.0-47-generic-x86_64-with-debian-buster-sid
Supports: All remotes
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
```