Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

Update docs to reflect default prune settings #1650

Merged
merged 1 commit into from
Feb 21, 2018
Merged
Changes from all 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
6 changes: 4 additions & 2 deletions docs/Gopkg.toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,12 @@ The following are the current available options:

Out of an abundance of caution, dep non-optionally preserves files that may have legal significance.

Pruning is disabled by default. It can be enabled by setting them to `true` at the root level.
Pruning options are disabled by default. However, generating a `Gopkg.toml` via `dep init` will add lines to enable `go-tests` and `unused-packages` prune options at the root level.

```toml
[prune]
non-go = true
go-tests = true
unused-packages = true
```

The same prune options can be defined per-project. An addtional `name` field is required and, as with `[[constraint]]` and `[[override]]`, should be a [source root](glossary.md#source-root), not just any import path.
Expand Down