This repository was archived by the owner on Sep 9, 2020. It is now read-only.
Explain useage of manifest and lock in the FAQ #516
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sdboyer
reviewed
May 4, 2017
FAQ.md
Outdated
| @@ -16,6 +18,20 @@ Summarize the question and quote the reply, linking back to the original comment | |||
| * [Can I put the manifest and lock in the vendor directory?](#can-i-put-the-manifest-and-lock-in-the-vendor-directory) | |||
| * [Why did dep use a different revision for package X instead of the revision in the lock file?](#why-did-dep-use-a-different-revision-for-package-x-instead-of-the-revision-in-the-lock-file) | |||
|
|
|||
| ## What is the difference between the manifest and lock? | |||
There was a problem hiding this comment.
Let's revise to
"What is the difference between Gopkg.toml (the "manifest") and Gopkg.lock (the "lock")?"
That way we don't assume people are familiar with the abstract terminology of manifest/lock
|
I've updated the question to include the manifest and lock filenames. Looks like the Travis build needs to be restarted though. |
|
@sdboyer Is there anything else left that I need to do before this can be merged? |
sdboyer
suggested changes
May 10, 2017
FAQ.md
Outdated
| ## When should I use dependencies, overrides, required, or ignored in the manifest? | ||
|
|
||
| * Use `dependencies` to constrain a [direct dependency](#what-is-a-direct-or-transitive-dependency) to a specific branch, version range, revision, or specify an alternate source such as a fork. | ||
| * Use `overrides` to constrain a [transitive dependency](#what-is-a-direct-or-transitive-dependency). See [How do I constrain a transitive dependency's version?](#how-do-i-constrain-a-transitive-dependencys-version) for more details on when each section applies. |
There was a problem hiding this comment.
Let's add a note here that overrides should be used cautiously, sparingly and temporarily.
FAQ.md
Outdated
|
|
||
| > The manifest describes user intent, and the lock describes computed outputs. There's flexibility in manifests that isn't present in locks..., as the "branch": "master" constraint will match whatever revision master HAPPENS to be at right now, whereas the lock is nailed down to a specific revision. | ||
| > | ||
| > This flexibility is important because it allows us to provide easy commands (e.g. dep ensure -update) that can manage an update process for you, within the constraints you specify, AND because it allows your project, when imported by someone else, to collaboratively specify the constraints for your own dependencies. |
There was a problem hiding this comment.
backticks around dep ensure -update
|
sorry, too many plates 😄 |
sdboyer
approved these changes
May 11, 2017
|
totes brills 💇♂️ |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.