README
¶
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!
Directories
¶
| Path | Synopsis |
|---|---|
|
Package filenotify provides a mechanism for watching file(s) for changes.
|
Package filenotify provides a mechanism for watching file(s) for changes. |
|
checker
Package checker provide Docker specific implementations of the go-check.Checker interface.
|
Package checker provide Docker specific implementations of the go-check.Checker interface. |
|
Package jsonlog provides helper functions to parse and print time (time.Time) as JSON.
|
Package jsonlog provides helper functions to parse and print time (time.Time) as JSON. |
|
Package locker provides a mechanism for creating finer-grained locking to help free up more global locks to handle other tasks.
|
Package locker provides a mechanism for creating finer-grained locking to help free up more global locks to handle other tasks. |
|
Package parsers provides helper functions to parse and validate different type of string.
|
Package parsers provides helper functions to parse and validate different type of string. |
|
kernel
Package kernel provides helper function to get, parse and compare kernel versions for different platforms.
|
Package kernel provides helper function to get, parse and compare kernel versions for different platforms. |
|
operatingsystem
Package operatingsystem provides helper function to get the operating system name for different platforms.
|
Package operatingsystem provides helper function to get the operating system name for different platforms. |
|
Package pidfile provides structure and helper functions to create and remove PID file.
|
Package pidfile provides structure and helper functions to create and remove PID file. |
|
Package platform provides helper function to get the runtime architecture for different platforms.
|
Package platform provides helper function to get the runtime architecture for different platforms. |
|
Package plugins provides structures and helper functions to manage Docker plugins.
|
Package plugins provides structures and helper functions to manage Docker plugins. |
|
Package pools provides a collection of pools which provide various data types with buffers.
|
Package pools provides a collection of pools which provide various data types with buffers. |
|
Package proxy provides a network Proxy interface and implementations for TCP and UDP.
|
Package proxy provides a network Proxy interface and implementations for TCP and UDP. |
|
Package signal provides helper functions for dealing with signals across various operating systems.
|
Package signal provides helper functions for dealing with signals across various operating systems. |
|
Package sockets provides helper functions to create and configure Unix or TCP sockets.
|
Package sockets provides helper functions to create and configure Unix or TCP sockets. |
|
Package streamformatter provides helper functions to format a stream.
|
Package streamformatter provides helper functions to format a stream. |
|
Package stringid provides helper functions for dealing with string identifiers
|
Package stringid provides helper functions for dealing with string identifiers |
|
Package stringutils provides helper functions for dealing with strings.
|
Package stringutils provides helper functions for dealing with strings. |
|
Package tailfile provides helper functions to read the nth lines of any ReadSeeker.
|
Package tailfile provides helper functions to read the nth lines of any ReadSeeker. |
|
Package tarsum provides algorithms to perform checksum calculation on filesystem layers.
|
Package tarsum provides algorithms to perform checksum calculation on filesystem layers. |
|
Package term provides provides structures and helper functions to work with terminal (state, sizes).
|
Package term provides provides structures and helper functions to work with terminal (state, sizes). |
|
Package timeoutconn provides overridden net.Conn that supports deadline (timeout).
|
Package timeoutconn provides overridden net.Conn that supports deadline (timeout). |
|
Package tlsconfig provides primitives to retrieve secure-enough TLS configurations for both clients and servers.
|
Package tlsconfig provides primitives to retrieve secure-enough TLS configurations for both clients and servers. |
|
Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id.
|
Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id. |
|
Package ulimit provides structure and helper function to parse and represent resource limits (Rlimit and Ulimit, its human friendly version).
|
Package ulimit provides structure and helper function to parse and represent resource limits (Rlimit and Ulimit, its human friendly version). |
|
Package units provides helper function to parse and print size and time units in human-readable format.
|
Package units provides helper function to parse and print size and time units in human-readable format. |
|
Package urlutil provides helper function to check urls kind.
|
Package urlutil provides helper function to check urls kind. |
|
Package useragent provides helper functions to pack version information into a single User-Agent header.
|
Package useragent provides helper functions to pack version information into a single User-Agent header. |
Click to show internal directories.
Click to hide internal directories.