Closes #195: Added documentation for the glide.yaml file.
diff --git a/cfg/cfg.go b/cfg/cfg.go index e370c13..6204bad 100644 --- a/cfg/cfg.go +++ b/cfg/cfg.go
@@ -3,4 +3,56 @@ // The cfg package contains the ability to parse (unmarshal) and write (marshal) // glide.yaml and glide.lock files. These files contains the details about // projects managed by Glide. +// +// To convert yaml into a cfg.Config instance use the cfg.ConfigFromYaml function. +// The yaml, typically in a glide.yaml file, has the following structure. +// +// package: github.com/Masterminds/glide +// homepage: https://masterminds.github.io/glide +// license: MIT +// owners: +// - name: Matt Butcher +// email: technosophos@gmail.com +// homepage: http://technosophos.com +// - name: Matt Farina +// email: matt@mattfarina.com +// homepage: https://www.mattfarina.com +// ignore: +// - appengine +// import: +// - package: gopkg.in/yaml.v2 +// - package: github.com/Masterminds/vcs +// version: ^1.2.0 +// repo: git@github.com:Masterminds/vcs +// vcs: git +// - package: github.com/codegangsta/cli +// - package: github.com/Masterminds/semver +// version: ^1.0.0 +// +// These elements are: +// - package: The top level package is the location in the GOPATH. This is used +// for things such as making sure an import isn't also importing the top level +// package. +// - homepage: To find the place where you can find details about the package or +// applications. For example, http://k8s.io +// - license: The license is either an SPDX license string or the filepath to the +// license. This allows automation and consumers to easily identify the license. +// - owners: The owners is a list of one or more owners for the project. This +// can be a person or organization and is useful for things like notifying the +// owners of a security issue without filing a public bug. +// - ignore: A list of packages for Glide to ignore importing. These are package +// names to ignore rather than directories. +// - import: A list of packages to import. Each package can include: +// - package: The name of the package to import and the only non-optional item. +// - version: A semantic version, semantic version range, branch, tag, or +// commit id to use. +// - 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. +// - devImport: A list of development packages. Each package has the same details +// as those lised under import. package cfg
diff --git a/glide.lock b/glide.lock index 3ff76ad..ef461c7 100644 --- a/glide.lock +++ b/glide.lock
@@ -1,12 +1,12 @@ -hash: 4cf59f8e61ae7034d3296c0c7528aaf8784800008814fb02410cbb3ea9b34175 -updated: 2016-01-21T11:19:37.465408253-05:00 +hash: 1d4d06656329894abc78c0ac256169337c947260b784fee7ed02a0e405c0f63b +updated: 2016-01-28T11:15:09.190330904-05:00 imports: - name: github.com/codegangsta/cli version: c31a7975863e7810c92e2e288a9ab074f9a88f29 - name: github.com/Masterminds/semver version: 513f3dcb3ecfb1248831fb5cb06a23a3cd5935dc - name: github.com/Masterminds/vcs - version: eaee272c8fa4514e1572e182faecff5be20e792a + version: 4e0f9d754b04dbb4fc9a62aa5ef6bf22ee0937a8 - name: gopkg.in/yaml.v2 version: f7716cbe52baa25d2e9b0d0da546fcf909fc16b4 devImports: []
diff --git a/glide.yaml b/glide.yaml index 611d71c..09401c9 100644 --- a/glide.yaml +++ b/glide.yaml
@@ -1,4 +1,13 @@ package: github.com/Masterminds/glide +homepage: https://github.com/Masterminds/glide +license: MIT +owners: +- name: Matt Butcher + email: technosophos@gmail.com + homepage: http://technosophos.com/ +- name: Matt Farina + email: matt@mattfarina.com + homepage: https://www.mattfarina.com/ import: - package: gopkg.in/yaml.v2 - package: github.com/Masterminds/vcs