Skip to content

Commit

Permalink
config: add top-level docs
Browse files Browse the repository at this point in the history
Signed-off-by: Hank Donnay <hdonnay@redhat.com>
  • Loading branch information
hdonnay committed Mar 21, 2022
1 parent ce462ea commit 6a99b61
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions config/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Package config is the configuration package for Clair's binaries. See the
// Config type for the main entry point.
//
// It's currently meant for reading configs and tested against YAML and JSON.
package config

// This pakcage can't use "omitempty" tags on slices because "not present" and
// "empty" aren't distinguished. This would be much easier if code didn't
// serialize our config struct. It's impossible to implement custom YAML
// marshalling without importing the yaml.v3 package.

0 comments on commit 6a99b61

Please sign in to comment.