From f73d72bfdccc330f5040d6c98a7dace461598c61 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 30 Sep 2022 17:11:37 +0200 Subject: [PATCH] pkg: replace some README's with GoDoc package descriptions Signed-off-by: Sebastiaan van Stijn --- pkg/archive/README.md | 1 - pkg/archive/archive.go | 1 + pkg/reexec/README.md | 5 ----- pkg/reexec/reexec.go | 4 ++++ pkg/stringid/README.md | 1 - pkg/sysinfo/README.md | 1 - pkg/sysinfo/sysinfo.go | 1 + 7 files changed, 6 insertions(+), 8 deletions(-) delete mode 100644 pkg/archive/README.md delete mode 100644 pkg/reexec/README.md delete mode 100644 pkg/stringid/README.md delete mode 100644 pkg/sysinfo/README.md diff --git a/pkg/archive/README.md b/pkg/archive/README.md deleted file mode 100644 index 7307d9694f..0000000000 --- a/pkg/archive/README.md +++ /dev/null @@ -1 +0,0 @@ -This code provides helper functions for dealing with archive files. diff --git a/pkg/archive/archive.go b/pkg/archive/archive.go index cdaf7ea2a3..7827aee46b 100644 --- a/pkg/archive/archive.go +++ b/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" import ( diff --git a/pkg/reexec/README.md b/pkg/reexec/README.md deleted file mode 100644 index 6658f69b69..0000000000 --- a/pkg/reexec/README.md +++ /dev/null @@ -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. diff --git a/pkg/reexec/reexec.go b/pkg/reexec/reexec.go index f8ccddd599..54e934c2a0 100644 --- a/pkg/reexec/reexec.go +++ b/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" import ( diff --git a/pkg/stringid/README.md b/pkg/stringid/README.md deleted file mode 100644 index 37a5098fd9..0000000000 --- a/pkg/stringid/README.md +++ /dev/null @@ -1 +0,0 @@ -This package provides helper functions for dealing with string identifiers diff --git a/pkg/sysinfo/README.md b/pkg/sysinfo/README.md deleted file mode 100644 index c1530cef0d..0000000000 --- a/pkg/sysinfo/README.md +++ /dev/null @@ -1 +0,0 @@ -SysInfo stores information about which features a kernel supports. diff --git a/pkg/sysinfo/sysinfo.go b/pkg/sysinfo/sysinfo.go index 3078ecef36..ab86711c46 100644 --- a/pkg/sysinfo/sysinfo.go +++ b/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" import "github.com/docker/docker/pkg/parsers"