Browse code

First header should be a top level header

Signed-off-by: yupeng <yu.peng36@zte.com.cn>

yupeng authored on 2016/11/21 18:08:28
Showing 4 changed files
... ...
@@ -1,10 +1,10 @@
1
-## Legacy API type versions
1
+# Legacy API type versions
2 2
 
3 3
 This package includes types for legacy API versions. The stable version of the API types live in `api/types/*.go`.
4 4
 
5 5
 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`.
6 6
 
7
-### Package name conventions
7
+## Package name conventions
8 8
 
9 9
 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:
10 10
 
... ...
@@ -1,4 +1,4 @@
1
-## Go client for the Docker Remote API
1
+# Go client for the Docker Remote API
2 2
 
3 3
 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.
4 4
 
... ...
@@ -1,6 +1,6 @@
1
-## devicemapper - a storage backend based on Device Mapper
1
+# devicemapper - a storage backend based on Device Mapper
2 2
 
3
-### Theory of operation
3
+## Theory of operation
4 4
 
5 5
 The device mapper graphdriver uses the device mapper thin provisioning
6 6
 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
39 39
 images are then in turn used as snapshots for other images and
40 40
 eventually containers.
41 41
 
42
-### Information on `docker info`
42
+## Information on `docker info`
43 43
 
44 44
 As of docker-1.4.1, `docker info` when using the `devicemapper` storage driver
45 45
 will display something like:
... ...
@@ -64,7 +64,7 @@ will display something like:
64 64
 	 Library Version: 1.02.82-git (2013-10-04)
65 65
 	[...]
66 66
 
67
-#### status items
67
+### status items
68 68
 
69 69
 Each item in the indented section under `Storage Driver: devicemapper` are
70 70
 status information about the driver.
... ...
@@ -84,7 +84,7 @@ status information about the driver.
84 84
  *  `Metadata loop file` file attached to `Metadata file`, if loopback device is used
85 85
  *  `Library Version` from the libdevmapper used
86 86
 
87
-### About the devicemapper options
87
+## About the devicemapper options
88 88
 
89 89
 The devicemapper backend supports some options that you can specify
90 90
 when starting the docker daemon using the `--storage-opt` flags.
... ...
@@ -1,4 +1,4 @@
1
-## reexec
1
+# reexec
2 2
 
3 3
 The `reexec` package facilitates the busybox style reexec of the docker binary that we require because 
4 4
 of the forking limitations of using Go.  Handlers can be registered with a name and the argv 0 of