Browse Source

Merge pull request #44222 from thaJeztah/godoc_instead_of_readme

Samuel Karp 2 years ago
parent
commit
c9d2b7df77

+ 0 - 1
pkg/archive/README.md

@@ -1 +0,0 @@
-This code provides helper functions for dealing with archive files.

+ 1 - 0
pkg/archive/archive.go

@@ -1,3 +1,4 @@
+// Package archive provides helper functions for dealing with archive files.
 package archive // import "github.com/docker/docker/pkg/archive"
 package archive // import "github.com/docker/docker/pkg/archive"
 
 
 import (
 import (

+ 0 - 5
pkg/reexec/README.md

@@ -1,5 +0,0 @@
-# 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 
-the exec of the binary will be used to find and execute custom init paths.

+ 4 - 0
pkg/reexec/reexec.go

@@ -1,3 +1,7 @@
+// Package reexec 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 the exec of the binary will be used
+// to find and execute custom init paths.
 package reexec // import "github.com/docker/docker/pkg/reexec"
 package reexec // import "github.com/docker/docker/pkg/reexec"
 
 
 import (
 import (

+ 0 - 1
pkg/stringid/README.md

@@ -1 +0,0 @@
-This package provides helper functions for dealing with string identifiers

+ 0 - 1
pkg/sysinfo/README.md

@@ -1 +0,0 @@
-SysInfo stores information about which features a kernel supports.

+ 1 - 0
pkg/sysinfo/sysinfo.go

@@ -1,3 +1,4 @@
+// Package sysinfo stores information about which features a kernel supports.
 package sysinfo // import "github.com/docker/docker/pkg/sysinfo"
 package sysinfo // import "github.com/docker/docker/pkg/sysinfo"
 
 
 import "github.com/docker/docker/pkg/parsers"
 import "github.com/docker/docker/pkg/parsers"