From 71a8b542f95cf34746d1b544a0fe1790a9f6eb09 Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Fri, 13 Jan 2017 16:48:46 -0500 Subject: [PATCH] ext: misc doc comment fixes --- ext/imagefmt/aci/aci.go | 2 ++ ext/imagefmt/docker/docker.go | 2 ++ ext/imagefmt/driver.go | 6 +++--- ext/versionfmt/dpkg/parser.go | 4 +++- ext/versionfmt/rpm/parser.go | 4 +++- 5 files changed, 13 insertions(+), 5 deletions(-) diff --git a/ext/imagefmt/aci/aci.go b/ext/imagefmt/aci/aci.go index 38e26217..ed6fd5b8 100644 --- a/ext/imagefmt/aci/aci.go +++ b/ext/imagefmt/aci/aci.go @@ -12,6 +12,8 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package aci implements an imagefmt.Extractor for appc formatted container +// image layers. package aci import ( diff --git a/ext/imagefmt/docker/docker.go b/ext/imagefmt/docker/docker.go index 94f866fd..e69ee2e4 100644 --- a/ext/imagefmt/docker/docker.go +++ b/ext/imagefmt/docker/docker.go @@ -12,6 +12,8 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package docker implements an imagefmt.Extractor for docker formatted +// container image layers. package docker import ( diff --git a/ext/imagefmt/driver.go b/ext/imagefmt/driver.go index 81d8ce3f..6b14f48e 100644 --- a/ext/imagefmt/driver.go +++ b/ext/imagefmt/driver.go @@ -51,7 +51,7 @@ type Extractor interface { ExtractFiles(layer io.ReadCloser, filenames []string) (tarutil.FilesMap, error) } -// RegisterExtractor makes a extractor available by the provided name. +// RegisterExtractor makes an extractor available by the provided name. // // If called twice with the same name, the name is blank, or if the provided // Extractor is nil, this function panics. @@ -60,11 +60,11 @@ func RegisterExtractor(name string, d Extractor) { defer extractorsM.Unlock() if name == "" { - panic("imagefmt: could not register a extractor with an empty name") + panic("imagefmt: could not register an Extractor with an empty name") } if d == nil { - panic("imagefmt: could not register a nil extractor") + panic("imagefmt: could not register a nil Extractor") } // Enforce lowercase names, so that they can be reliably be found in a map. diff --git a/ext/versionfmt/dpkg/parser.go b/ext/versionfmt/dpkg/parser.go index d170c9ca..42fbd45e 100644 --- a/ext/versionfmt/dpkg/parser.go +++ b/ext/versionfmt/dpkg/parser.go @@ -1,4 +1,4 @@ -// Copyright 2016 clair authors +// Copyright 2017 clair authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,6 +12,8 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package dpkg implements a versionfmt.Parser for version numbers used in dpkg +// based software packages. package dpkg import ( diff --git a/ext/versionfmt/rpm/parser.go b/ext/versionfmt/rpm/parser.go index 42fb71ab..a05f14d6 100644 --- a/ext/versionfmt/rpm/parser.go +++ b/ext/versionfmt/rpm/parser.go @@ -1,4 +1,4 @@ -// Copyright 2016 clair authors +// Copyright 2017 clair authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,6 +12,8 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package rpm implements a versionfmt.Parser for version numbers used in rpm +// based software packages. package rpm import (