diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f915bf8fe..673d808646 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,7 +21,7 @@ BUG FIXES: NEW FEATURES: * Absorb `dep prune` into `dep ensure`. ([#944](https://github.com/golang/dep/issues/944)) -* Add support for importing from [glock](https://github.com/robfig/glock) based projects. ([#1422](https://github.com/golang/dep/pull/1422) +* Add support for importing from [glock](https://github.com/robfig/glock) based projects. ([#1422](https://github.com/golang/dep/pull/1422)) * Add support for importing from [govendor](https://github.com/kardianos/govendor) based projects. ([#815](https://github.com/golang/dep/pull/815)) * Allow override of cache directory location using environment variable `DEPCACHEDIR`. ([#1234](https://github.com/golang/dep/pull/1234)) * Add support for template output in `dep status`. ([#1389](https://github.com/golang/dep/pull/1389)) diff --git a/docs/daily-dep.md b/docs/daily-dep.md index faf22617cd..6108050f20 100644 --- a/docs/daily-dep.md +++ b/docs/daily-dep.md @@ -101,7 +101,7 @@ Only if it is the first/last import of a project being added/removed - cases 3 a ### Rule changes in `Gopkg.toml` -`Gopkg.toml` files contain five basic types of rules. The [`Gopkg.toml` docs](#gopkg.toml.md) explain them in detail, but here's an overview: +`Gopkg.toml` files contain five basic types of rules. The [`Gopkg.toml` docs](gopkg.toml.md) explain them in detail, but here's an overview: * `required`, which are mostly equivalent to `import` statements in `.go` files, except that it's OK to list a `main` package here * `ignored`, which causes dep to black hole an import path (and any imports it uniquely introduces) diff --git a/docs/failure-modes.md b/docs/failure-modes.md index f06acca0a7..16abc942f2 100644 --- a/docs/failure-modes.md +++ b/docs/failure-modes.md @@ -55,7 +55,7 @@ The exact error text will vary depending on which of the operations is running, Almost any case where a dep command, run with `-v`, hangs for more than ten minutes will ultimately be a bug. However, the most common explanation for an apparent dep hangs is actually normal behavior: because dep's operation requires that it keep its own copies of upstream sources hidden away in the [local cache](glossary.md#local-cache), the first run of dep against a project, especially large projects, can take a long time while it populates the cache. -The only known case where dep may hang indefinitely is if one of the underlying VCS binaries it calls is prompting for some kind of input. Typically this means credentials (though not always - make sure to accept remote hosts' SSH keys into your known hosts!), and dep's normal assumption is that necessary credentials have been provided via environmental mechanisms - [configuration files or daemons](FAQ.md#how-do-i-get-dep-to-authenticate-to-a-git-repo), SSH agents, etc. This assumption is necessary for dep's concurrent network activity to work. If your use case absolutely cannot support the use of any such environmental caching mechanism, [please weigh in on this issue](). +The only known case where dep may hang indefinitely is if one of the underlying VCS binaries it calls is prompting for some kind of input. Typically this means credentials (though not always - make sure to accept remote hosts' SSH keys into your known hosts!), and dep's normal assumption is that necessary credentials have been provided via environmental mechanisms - [configuration files or daemons](FAQ.md#how-do-i-get-dep-to-authenticate-to-a-git-repo), SSH agents, etc. This assumption is necessary for dep's concurrent network activity to work. If your use case absolutely cannot support the use of any such environmental caching mechanism, [please weigh in on this issue](https://github.com/golang/dep/issues/1476). Unfortunately, until dep [improves the observability of its ongoing I/O operations](), it cannot accurately report to the user which operations are actually underway at any given moment. This can make it difficult to differentiate from other hangs - credentials prompts, long network timeouts induced by firewalls, sluggish TCP when faced with packet loss, etc.