arno/clair
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ext: misc doc comment fixes

Browse Source
This commit is contained in:
Jimmy Zelinskie 2017-01-13 16:48:46 -05:00
parent fb193e1fde
commit 71a8b542f9
5 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ext/imagefmt/aci/aci.go
View File

@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
// Package aci implements an imagefmt.Extractor for appc formatted container
// image layers.
package aci package aci
import ( import (

2
ext/imagefmt/docker/docker.go
View File

@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
// Package docker implements an imagefmt.Extractor for docker formatted
// container image layers.
package docker package docker
import ( import (

6
ext/imagefmt/driver.go
View File

@ -51,7 +51,7 @@ type Extractor interface {
ExtractFiles(layer io.ReadCloser, filenames []string) (tarutil.FilesMap, error) 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 // If called twice with the same name, the name is blank, or if the provided
// Extractor is nil, this function panics. // Extractor is nil, this function panics.
@ -60,11 +60,11 @@ func RegisterExtractor(name string, d Extractor) {
defer extractorsM.Unlock() defer extractorsM.Unlock()
if name == "" { 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 { 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. // Enforce lowercase names, so that they can be reliably be found in a map.

4
ext/versionfmt/dpkg/parser.go
View File

@ -1,4 +1,4 @@
// Copyright 2016 clair authors // Copyright 2017 clair authors
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with 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 // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
// Package dpkg implements a versionfmt.Parser for version numbers used in dpkg
// based software packages.
package dpkg package dpkg
import ( import (

4
ext/versionfmt/rpm/parser.go
View File

@ -1,4 +1,4 @@
// Copyright 2016 clair authors // Copyright 2017 clair authors
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with 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 // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
// Package rpm implements a versionfmt.Parser for version numbers used in rpm
// based software packages.
package rpm package rpm
import ( import (