Skip to content

Commit

Permalink
docs: gomod: Document --force-gomod-tidy deprecation
Browse files Browse the repository at this point in the history
Resolves: #713

Signed-off-by: Erik Skultety <eskultet@redhat.com>
  • Loading branch information
eskultety committed Jan 8, 2025
1 parent fb522d9 commit fc087e3
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions docs/gomod.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,12 @@ by Cachi2 anyway.
The `cachi2 fetch-deps` command accepts the following gomod-related flags:

* [--cgo-disable](#--cgo-disable)
* [--force-gomod-tidy](#--force-gomod-tidy)

### Deprecated flags

* `--gomod-vendor` (deprecated in _v0.11.0_)
* `--gomod-vendor-check` (deprecated in _v0.11.0_)
* `--force-gomod-tidy` (deprecated in _v0.18.0_)

All of them are deprecated and will have no effect when set. They are only kept for backwards
compatibility reasons and will be removed in future releases.
Expand All @@ -109,12 +109,6 @@ disable cgo in your build (nor should you disable it yourself if you rely on C).
Disabling cgo should not prevent Cachi2 from fetching your Go dependencies as usual. Note that Cachi2 will not make any
attempts to fetch missing C libraries. If required, you would need to get them through other means.

### --force-gomod-tidy

Makes Cachi2 run `go mod tidy` after downloading dependencies.

⚠ This flag is questionable and may be removed in the future.

## Vendoring

Go supports [vendoring](https://go.dev/ref/mod#vendoring) to store the source code of all dependencies in the vendor/
Expand Down

0 comments on commit fc087e3

Please sign in to comment.