vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Remove the example

Browse source 
Instead, direct users to the one in the factory package

Signed-off-by: Aaron Schlesinger <aschlesinger@deis.com>
This commit is contained in:
Aaron Schlesinger 2016-03-24 09:35:04 -07:00
parent 0f09bcd16a
commit 091ad89197
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/storage/driver/storagedriver.go
View file

@ -37,11 +37,8 @@ const CurrentVersion Version = "0.1"
// filesystem-like key/value object storage. Storage Drivers are automatically
// registered via an internal registration mechanism, and generally created
// via the StorageDriverFactory interface (https://godoc.org/github.com/docker/distribution/registry/storage/driver/factory).
// See below for an example of how to get a StorageDriver for S3:
//
// import _ "github.com/docker/distribution/registry/storage/driver/s3-aws"
// s3Driver, err = factory.Create("s3", storageParams)
// // assuming no error, s3Driver is the StorageDriver that communicates with S3 according to storageParams
// Please see the aforementioned factory package for example code showing how to get an instance
// of a StorageDriver
type StorageDriver interface {
// Name returns the human-readable "name" of the driver, useful in error
// messages and logging. By convention, this will just be the registration