Trim out/tighten up examples text

golang · Apr 28, 2017 · f4079c9 · f4079c9
1 parent ad41001
commit f4079c9
Show file tree

Hide file tree

Showing 15 changed files with 135 additions and 255 deletions.
diff --git a/cmd/dep/testdata/harness_tests/ensure/empty/case1/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/ensure/empty/case1/final/Gopkg.toml
@@ -1,4 +1,7 @@
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -15,27 +18,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/ensure/empty/case2/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/ensure/empty/case2/final/Gopkg.toml
@@ -3,6 +3,9 @@
   name = "github.com/sdboyer/deptest"
   version = "^0.8.0"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -19,27 +22,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/ensure/empty/case3/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/ensure/empty/case3/final/Gopkg.toml
@@ -4,6 +4,9 @@ ignored = ["github.com/sdboyer/deptestdos"]
   branch = "master"
   name = "github.com/sdboyer/deptest"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -20,27 +23,16 @@ ignored = ["github.com/sdboyer/deptestdos"]
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/ensure/override/case1/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/ensure/override/case1/final/Gopkg.toml
@@ -3,6 +3,9 @@
   name = "github.com/sdboyer/deptest"
   version = "1.0.0"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -19,27 +22,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/init/case1/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/init/case1/final/Gopkg.toml
@@ -7,6 +7,9 @@
   name = "github.com/sdboyer/deptestdos"
   revision = "a0196baa11ea047dd65037287451d36b861b00ea"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -23,27 +26,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/init/case2/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/init/case2/final/Gopkg.toml
@@ -3,6 +3,9 @@
   name = "github.com/sdboyer/deptest"
   version = ">=0.8.0, <1.0.0"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -19,27 +22,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/init/case3/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/init/case3/final/Gopkg.toml
@@ -7,6 +7,9 @@
   name = "github.com/sdboyer/deptestdos"
   revision = "a0196baa11ea047dd65037287451d36b861b00ea"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -23,27 +26,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/init/skip-hidden/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/init/skip-hidden/final/Gopkg.toml
@@ -1,4 +1,7 @@
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -15,27 +18,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when

diff --git a/cmd/dep/testdata/harness_tests/remove/force/case1/final/Gopkg.toml b/cmd/dep/testdata/harness_tests/remove/force/case1/final/Gopkg.toml
@@ -3,6 +3,9 @@
   name = "github.com/sdboyer/deptest"
   version = ">=0.8.0, <1.0.0"
 
+
+## EXAMPLES & DOCS - safe to delete!
+
 ## Dependencies define constraints on how dependent projects should be
 ## incorporated into Gopkg.lock. They are respected by dep whether
 ## this project is the current project, or if it's a dependency.
@@ -19,27 +22,16 @@
 ## bzr a 3-part id, svn a revision number.
 # revision = "abc123"
 
-## Overrides have the same structure as [[dependencies]], but supercede all
-## [[dependencies]] declarations from all projects. However, only the current
-## project's overrides will apply.
+## [[overrides]] follow the exact same structure as [[dependencies]], but supercede
+## all [[dependencies]] declarations from all projects. Only the current project's
+## [[overrides]] are applied.
 ##
 ## Overrides are a sledgehammer, and should be used only as a last resort.
-# [[overrides]]
-## Required: the root import path of the project being constrained
-# name = "github.com/user/project"
-## Optional: an alternate location (URL or import path) for the project's source
-# source = "https://github.com/myfork/package.git"
-## Optional, but recommended: the version constraint to enforce for the project.
-## Only one of "branch", "version" or "revision" can be specified.
-# version = "1.0.0"
-# branch = "master"
-## Note: revision will depend on your repository type; git and hg have SHA1s,
-## bzr a 3-part id, svn a revision number.
-# revision = "abc123"
 
 ## "required" lists a set of packages (not projects) that must be included in
-## Gopkg.lock. This has the same effect as directly importing a package, but
-## can be used to require "main" packages.
+## Gopkg.lock. This list is merged with the set of packages imported by the current
+## project. Use it when your project needs a package it doesn't explicitly import -
+## including "main" packages.
 # required = ["github.com/user/thing/cmd/thing"]
 
 ## "ignored" lists a set of packages (not projects) that are ignored when