Skip to content

Commit

Permalink
gc: address suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
skshetry committed Mar 2, 2020
1 parent 07c8a87 commit 5611c60
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions public/static/docs/command-reference/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ Remove unused objects from <abbr>cache</abbr> or remote storage.
## Synopsis

```usage
usage: dvc gc [-h] [-q | -v] [-w] [-a] [-T] [-c] [-r REMOTE] [-f] [-j JOBS]
usage: dvc gc [-h] [-q | -v]
[-w] [-a] [-T] [-c] [-r REMOTE] [-f] [-j JOBS]
[-p [REPOS [REPOS ...]]]
```

Expand Down Expand Up @@ -46,9 +47,9 @@ restored using `dvc fetch`, as long as they have previously been uploaded with
useful if tags are used to track "checkpoints" of an experiment or project.
Note that both options can be combined, for example using the `-aT` flag.

- `-w`, `--workspace` - remove files in local cache. _This operation is
dangerous._ If `--all-tags` or `--all-branches` are specified, this flag is
not explicitly required.
- `-w`, `--workspace` - remove files in local cache that are not referenced in
the workspace. _This operation is dangerous._ If `--all-tags` or
`--all-branches` are specified, this flag is not explicitly required.

- `-p`, `--projects` - if a single remote or a single cache is shared among
different projects (e.g. a configuration like the one described
Expand Down Expand Up @@ -86,8 +87,9 @@ $ du -sh .dvc/cache/
7.4G .dvc/cache/
```

When you run `dvc gc` it removes all objects from cache that are not referenced
in the <abbr>workspace</abbr> (by collecting hash values from the DVC-files):
When you run `dvc gc --workspace` it removes all objects from cache that are not
referenced in the <abbr>workspace</abbr> (by collecting hash values from the
DVC-files):

```dvc
$ dvc gc --workspace
Expand Down

0 comments on commit 5611c60

Please sign in to comment.