From 3504ee1987dea5e5fe7c6332608f62dce9248fd9 Mon Sep 17 00:00:00 2001 From: "Andrew J. Stone" Date: Wed, 7 Feb 2018 17:48:26 -0500 Subject: [PATCH] Update docs to reflect default prune settings --- docs/Gopkg.toml.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/Gopkg.toml.md b/docs/Gopkg.toml.md index b60c79953a..748548e90c 100644 --- a/docs/Gopkg.toml.md +++ b/docs/Gopkg.toml.md @@ -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.