From f191bf69ffc09a969399d3aa459f02ab234d48d2 Mon Sep 17 00:00:00 2001 From: Nalin Dahyabhai Date: Thu, 14 Jul 2016 14:24:50 -0400 Subject: [PATCH] Remove more code Based on a patch by Grant Seltzer Signed-off-by: Nalin Dahyabhai --- README.md | 11 ------- archive/README.md | 1 - mflag/README.md | 40 ----------------------- plugins/pluginrpc-gen/README.md | 58 --------------------------------- reexec/README.md | 5 --- stringid/README.md | 1 - stringutils/README.md | 1 - sysinfo/README.md | 1 - 8 files changed, 118 deletions(-) delete mode 100644 README.md delete mode 100644 archive/README.md delete mode 100644 mflag/README.md delete mode 100644 plugins/pluginrpc-gen/README.md delete mode 100644 reexec/README.md delete mode 100644 stringid/README.md delete mode 100644 stringutils/README.md delete mode 100644 sysinfo/README.md diff --git a/README.md b/README.md deleted file mode 100644 index c4b78a8..0000000 --- a/README.md +++ /dev/null @@ -1,11 +0,0 @@ -pkg/ is a collection of utility packages used by the Docker project without being specific to its internals. - -Utility packages are kept separate from the docker core codebase to keep it as small and concise as possible. -If some utilities grow larger and their APIs stabilize, they may be moved to their own repository under the -Docker organization, to facilitate re-use by other projects. However that is not the priority. - -The directory `pkg` is named after the same directory in the camlistore project. Since Brad is a core -Go maintainer, we thought it made sense to copy his methods for organizing Go code :) Thanks Brad! - -Because utility packages are small and neatly separated from the rest of the codebase, they are a good -place to start for aspiring maintainers and contributors. Get in touch if you want to help maintain them! diff --git a/archive/README.md b/archive/README.md deleted file mode 100644 index 7307d96..0000000 --- a/archive/README.md +++ /dev/null @@ -1 +0,0 @@ -This code provides helper functions for dealing with archive files. diff --git a/mflag/README.md b/mflag/README.md deleted file mode 100644 index 5e81bb2..0000000 --- a/mflag/README.md +++ /dev/null @@ -1,40 +0,0 @@ -Package mflag (aka multiple-flag) implements command-line flag parsing. -It's a **hacky** fork of the [official golang package](http://golang.org/pkg/flag/) - -It adds: - -* both short and long flag version -`./example -s red` `./example --string blue` - -* multiple names for the same option -``` -$>./example -h -Usage of example: - -s, --string="": a simple string -``` - -___ -It is very flexible on purpose, so you can do things like: -``` -$>./example -h -Usage of example: - -s, -string, --string="": a simple string -``` - -Or: -``` -$>./example -h -Usage of example: - -oldflag, --newflag="": a simple string -``` - -You can also hide some flags from the usage, so if we want only `--newflag`: -``` -$>./example -h -Usage of example: - --newflag="": a simple string -$>./example -oldflag str -str -``` - -See [example.go](example/example.go) for more details. diff --git a/plugins/pluginrpc-gen/README.md b/plugins/pluginrpc-gen/README.md deleted file mode 100644 index 0418a3e..0000000 --- a/plugins/pluginrpc-gen/README.md +++ /dev/null @@ -1,58 +0,0 @@ -Plugin RPC Generator -==================== - -Generates go code from a Go interface definition for proxying between the plugin -API and the subsystem being extended. - -## Usage - -Given an interface definition: - -```go -type volumeDriver interface { - Create(name string, opts opts) (err error) - Remove(name string) (err error) - Path(name string) (mountpoint string, err error) - Mount(name string) (mountpoint string, err error) - Unmount(name string) (err error) -} -``` - -**Note**: All function options and return values must be named in the definition. - -Run the generator: - -```bash -$ pluginrpc-gen --type volumeDriver --name VolumeDriver -i volumes/drivers/extpoint.go -o volumes/drivers/proxy.go -``` - -Where: -- `--type` is the name of the interface to use -- `--name` is the subsystem that the plugin "Implements" -- `-i` is the input file containing the interface definition -- `-o` is the output file where the the generated code should go - -**Note**: The generated code will use the same package name as the one defined in the input file - -Optionally, you can skip functions on the interface that should not be -implemented in the generated proxy code by passing in the function name to `--skip`. -This flag can be specified multiple times. - -You can also add build tags that should be prepended to the generated code by -supplying `--tag`. This flag can be specified multiple times. - -## Known issues - -## go-generate - -You can also use this with go-generate, which is pretty awesome. -To do so, place the code at the top of the file which contains the interface -definition (i.e., the input file): - -```go -//go:generate pluginrpc-gen -i $GOFILE -o proxy.go -type volumeDriver -name VolumeDriver -``` - -Then cd to the package dir and run `go generate` - -**Note**: the `pluginrpc-gen` binary must be within your `$PATH` diff --git a/reexec/README.md b/reexec/README.md deleted file mode 100644 index 45592ce..0000000 --- a/reexec/README.md +++ /dev/null @@ -1,5 +0,0 @@ -## reexec - -The `reexec` package facilitates the busybox style reexec of the docker binary that we require because -of the forking limitations of using Go. Handlers can be registered with a name and the argv 0 of -the exec of the binary will be used to find and execute custom init paths. diff --git a/stringid/README.md b/stringid/README.md deleted file mode 100644 index 37a5098..0000000 --- a/stringid/README.md +++ /dev/null @@ -1 +0,0 @@ -This package provides helper functions for dealing with string identifiers diff --git a/stringutils/README.md b/stringutils/README.md deleted file mode 100644 index b3e4545..0000000 --- a/stringutils/README.md +++ /dev/null @@ -1 +0,0 @@ -This package provides helper functions for dealing with strings diff --git a/sysinfo/README.md b/sysinfo/README.md deleted file mode 100644 index c1530ce..0000000 --- a/sysinfo/README.md +++ /dev/null @@ -1 +0,0 @@ -SysInfo stores information about which features a kernel supports.