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

Commit c3d278d

Browse files
authored
Merge pull request #1451 from carolynvs/revert-prune-docs
Revert "Merge pull request #1405 from ibrasho-forks/prune-docs"
2 parents f31d439 + 6edfef6 commit c3d278d

File tree

2 files changed

+1
-37
lines changed

2 files changed

+1
-37
lines changed

docs/FAQ.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ It's up to you:
347347
**Cons**
348348

349349
- Your repo will be bigger, potentially a lot bigger,
350-
though [`prune`](Gopkg.toml.md#prune) can help minimize this problem.
350+
though `dep prune` can help minimize this problem.
351351
- PR diffs will include changes for files under `vendor/` when Gopkg.lock is modified,
352352
however files in `vendor/` are [hidden by default](https://github.com/github/linguist/blob/v5.2.0/lib/linguist/generated.rb#L328) on Github.
353353

docs/Gopkg.toml.md

-36
Original file line numberDiff line numberDiff line change
@@ -58,35 +58,6 @@ system1-data = "value that is used by a system"
5858
system2-data = "value that is used by another system"
5959
```
6060

61-
## `prune`
62-
`prune` defines the global and per-project prune options for dependencies. The options control which files are not kept when writing the `vendor/` tree.
63-
64-
The following is the current available options:
65-
* `unused-packages` prunes files in unused packages.
66-
* `non-go` prunes files that are not used by Go.
67-
* `go-tests` prunes Go test files.
68-
69-
Some files are preversed by default (check the [isPreservedFile](../gps/prune.go#L254) function for the details).
70-
71-
Prune options are off by default and can be turned on by setting them to `true` at the root level.
72-
```toml
73-
[prune]
74-
non-go = true
75-
```
76-
77-
The same prune options can be defined per-project. An addtional `name` field is required and should represent a project and not a package.
78-
79-
80-
```toml
81-
[prune]
82-
non-go = true
83-
84-
[[prune.project]]
85-
name = "github.com/project/name"
86-
go-tests = true
87-
non-go = false
88-
```
89-
9061
## `constraint`
9162
A `constraint` provides rules for how a [direct dependency](FAQ.md#what-is-a-direct-or-transitive-dependency) may be incorporated into the
9263
dependency graph.
@@ -200,11 +171,4 @@ codename = "foo"
200171

201172
[metadata]
202173
propertyX = "valueX"
203-
204-
[prune]
205-
unused-packages = true
206-
207-
[[prune.project]]
208-
name = "github.com/user/project2"
209-
unused-packages = false
210174
```

0 commit comments

Comments
 (0)