README
¶
pkg/ is a collection of utility packages used by the Moby project without being specific to its internals.
Utility packages are kept separate from the moby 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 Moby 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 aaparser is a convenience package interacting with `apparmor_parser`.
|
Package aaparser is a convenience package interacting with `apparmor_parser`. |
|
Package archive provides helper functions for dealing with archive files.
|
Package archive provides helper functions for dealing with archive files. |
|
Package capabilities allows to generically handle capabilities.
|
Package capabilities allows to generically handle capabilities. |
|
Package longpath introduces some constants and helper functions for handling long paths in Windows.
|
Package longpath introduces some constants and helper functions for handling long paths in Windows. |
|
Package meminfo provides utilites to retrieve memory statistics of the host system.
|
Package meminfo provides utilites to retrieve memory statistics of the host system. |
|
Package namesgenerator generates random names.
|
Package namesgenerator generates random names. |
|
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. |
|
pluginrpc-gen
command
|
|
|
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 process provides a set of basic functions to manage individual processes.
|
Package process provides a set of basic functions to manage individual processes. |
|
Package reexec facilitates the busybox style reexec of the docker binary that we require because of the forking limitations of using Go.
|
Package reexec facilitates the busybox style reexec of the docker binary that we require because of the forking limitations of using Go. |
|
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 sysinfo stores information about which features a kernel supports.
|
Package sysinfo stores information about which features a kernel supports. |
|
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 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.