Skip to content

Updating the docs on subpackages #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2016
Merged

Updating the docs on subpackages #431

merged 1 commit into from
May 25, 2016

Conversation

mattfarina
Copy link
Member

No description provided.

@@ -41,6 +41,7 @@ These elements are:
- `version`: A semantic version, semantic version range, branch, tag, or commit id to use. For more information see the [versioning documentation](versions.md).
- `repo`: If the package name isn't the repo location or this is a private repository it can go here. The package will be checked out from the repo and put where the package name specifies. This allows using forks.
- `vcs`: A VCS to use such as git, hg, bzr, or svn. This is only needed when the type cannot be detected from the name. For example, a repo ending in .git or on GitHub can be detected to be Git. For a repo on Bitbucket we can contact the API to discover the type.
- `subpackages`: A record of packages being used within a repository. This does not include all packages within a repository but rather those being used.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we have a note to say why we might care. As I understand it it is prevent all the (transitive) dependencies being fetched for a package within a repo that you don't use. Is that all?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@silasdavis There is not as much of a reason to have it as there used to be. This was far more important prior to the code scanning we have now.

This is useful in the lock files because other tools can use that information such as glide-vc.

@mattfarina mattfarina merged commit a20b232 into master May 25, 2016
@mattfarina mattfarina deleted the fix/subpkg-docs branch May 25, 2016 13:48
@xeger
Copy link

xeger commented Jun 1, 2016

@mattfarina I left a comment on #430 about the future of subpackages; I understand that their original purpose has fallen by the wayside, but there's an itch that's left unscratched, relating to versioning the binaries that one go installs by hand, and their dependencies on vendored source... Not sure that it's glide's place to scratch this itch but I was hoping to hear your perspective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants