diff --git a/api/types/versions/README.md b/api/types/versions/README.md index cdac50a53c..1ef911edb0 100644 --- a/api/types/versions/README.md +++ b/api/types/versions/README.md @@ -1,10 +1,10 @@ -## Legacy API type versions +# Legacy API type versions This package includes types for legacy API versions. The stable version of the API types live in `api/types/*.go`. Consider moving a type here when you need to keep backwards compatibility in the API. This legacy types are organized by the latest API version they appear in. For instance, types in the `v1p19` package are valid for API versions below or equal `1.19`. Types in the `v1p20` package are valid for the API version `1.20`, since the versions below that will use the legacy types in `v1p19`. -### Package name conventions +## Package name conventions The package name convention is to use `v` as a prefix for the version number and `p`(patch) as a separator. We use this nomenclature due to a few restrictions in the Go package name convention: diff --git a/client/README.md b/client/README.md index 2b7d81fada..161686c0a6 100644 --- a/client/README.md +++ b/client/README.md @@ -1,4 +1,4 @@ -## Go client for the Docker Remote API +# Go client for the Docker Remote API The `docker` command uses this package to communicate with the daemon. It can also be used by your own Go applications to do anything the command-line interface does – running containers, pulling images, managing swarms, etc. diff --git a/daemon/graphdriver/devmapper/README.md b/daemon/graphdriver/devmapper/README.md index b23bbb107a..792474a8a7 100644 --- a/daemon/graphdriver/devmapper/README.md +++ b/daemon/graphdriver/devmapper/README.md @@ -1,6 +1,6 @@ -## devicemapper - a storage backend based on Device Mapper +# devicemapper - a storage backend based on Device Mapper -### Theory of operation +## Theory of operation The device mapper graphdriver uses the device mapper thin provisioning module (dm-thinp) to implement CoW snapshots. The preferred model is @@ -39,7 +39,7 @@ containers. All base images are snapshots of this device and those images are then in turn used as snapshots for other images and eventually containers. -### Information on `docker info` +## Information on `docker info` As of docker-1.4.1, `docker info` when using the `devicemapper` storage driver will display something like: @@ -64,7 +64,7 @@ will display something like: Library Version: 1.02.82-git (2013-10-04) [...] -#### status items +### status items Each item in the indented section under `Storage Driver: devicemapper` are status information about the driver. @@ -84,7 +84,7 @@ status information about the driver. * `Metadata loop file` file attached to `Metadata file`, if loopback device is used * `Library Version` from the libdevmapper used -### About the devicemapper options +## About the devicemapper options The devicemapper backend supports some options that you can specify when starting the docker daemon using the `--storage-opt` flags. diff --git a/pkg/reexec/README.md b/pkg/reexec/README.md index 45592ce85a..6658f69b69 100644 --- a/pkg/reexec/README.md +++ b/pkg/reexec/README.md @@ -1,4 +1,4 @@ -## reexec +# 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