Skip to content

Commit 48c3df0

Browse files
authored
Merge pull request moby#28651 from YuPengZTE/devMD002
First header should be a top level header
2 parents d1258c7 + 1e65db4 commit 48c3df0

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

api/types/versions/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Legacy API type versions
1+
# Legacy API type versions
22

33
This package includes types for legacy API versions. The stable version of the API types live in `api/types/*.go`.
44

55
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`.
66

7-
### Package name conventions
7+
## Package name conventions
88

99
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:
1010

client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Go client for the Docker Remote API
1+
# Go client for the Docker Remote API
22

33
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.
44

daemon/graphdriver/devmapper/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## devicemapper - a storage backend based on Device Mapper
1+
# devicemapper - a storage backend based on Device Mapper
22

3-
### Theory of operation
3+
## Theory of operation
44

55
The device mapper graphdriver uses the device mapper thin provisioning
66
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
3939
images are then in turn used as snapshots for other images and
4040
eventually containers.
4141

42-
### Information on `docker info`
42+
## Information on `docker info`
4343

4444
As of docker-1.4.1, `docker info` when using the `devicemapper` storage driver
4545
will display something like:
@@ -64,7 +64,7 @@ will display something like:
6464
Library Version: 1.02.82-git (2013-10-04)
6565
[...]
6666

67-
#### status items
67+
### status items
6868

6969
Each item in the indented section under `Storage Driver: devicemapper` are
7070
status information about the driver.
@@ -84,7 +84,7 @@ status information about the driver.
8484
* `Metadata loop file` file attached to `Metadata file`, if loopback device is used
8585
* `Library Version` from the libdevmapper used
8686

87-
### About the devicemapper options
87+
## About the devicemapper options
8888

8989
The devicemapper backend supports some options that you can specify
9090
when starting the docker daemon using the `--storage-opt` flags.

pkg/reexec/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## reexec
1+
# reexec
22

33
The `reexec` package facilitates the busybox style reexec of the docker binary that we require because
44
of the forking limitations of using Go. Handlers can be registered with a name and the argv 0 of

0 commit comments

Comments
 (0)