diff options
| author |  Miek Gieben <miek@miek.nl>
| 2018-02-23 15:02:05 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2018-02-23 15:02:05 +0000 |
| commit | 455040c1439324d6c53841c9b877e4e7c76df31e (patch) | |
| tree | 096de5eb354b1f3e7d19a063e2303cdc3025e822 /plugin | |
| parent | e3b7beab6abd4c725b386ee5a89b344b5d4d413b (diff) | |
| download | coredns-455040c1439324d6c53841c9b877e4e7c76df31e.tar.gz coredns-455040c1439324d6c53841c9b877e4e7c76df31e.tar.zst coredns-455040c1439324d6c53841c9b877e4e7c76df31e.zip | |
doc: some function/vars/const/package level updates (#1558)
* doc: some function/vars/const/package level updates
Various update that stood out while reading godoc.org for CoreDNS.
* Fix some misspellings as well
Diffstat (limited to 'plugin')
| -rw-r--r-- | plugin/forward/metrics.go | 2 | ||||
| -rw-r--r-- | plugin/forward/setup.go | 2 | ||||
| -rw-r--r-- | plugin/pkg/fuzz/do.go | 1 | ||||
| -rw-r--r-- | plugin/pkg/parse/parse.go | 1 | ||||
| -rw-r--r-- | plugin/pkg/rcode/rcode.go | 3 | ||||
| -rw-r--r-- | plugin/pkg/up/up.go | 2 |
6 files changed, 7 insertions, 4 deletions
diff --git a/plugin/forward/metrics.go b/plugin/forward/metrics.go index 1e72454e0..b0368f722 100644 --- a/plugin/forward/metrics.go +++ b/plugin/forward/metrics.go @@ -45,7 +45,7 @@ var ( Namespace: plugin.Namespace, Subsystem: "forward", Name: "socket_count_total", - Help: "Guage of open sockets per upstream.", + Help: "Gauge of open sockets per upstream.", }, []string{"to"}) ) diff --git a/plugin/forward/setup.go b/plugin/forward/setup.go index 5231bcc22..779d085ae 100644 --- a/plugin/forward/setup.go +++ b/plugin/forward/setup.go @@ -25,7 +25,7 @@ func init() { func setup(c *caddy.Controller) error { f, err := parseForward(c) if err != nil { - return plugin.Error("foward", err) + return plugin.Error("forward", err) } if f.Len() > max { return plugin.Error("forward", fmt.Errorf("more than %d TOs configured: %d", max, f.Len())) diff --git a/plugin/pkg/fuzz/do.go b/plugin/pkg/fuzz/do.go index 920e8feb7..d4ef87117 100644 --- a/plugin/pkg/fuzz/do.go +++ b/plugin/pkg/fuzz/do.go @@ -1,3 +1,4 @@ +// Package fuzz contains functions that enable fuzzing of plugins. package fuzz import ( diff --git a/plugin/pkg/parse/parse.go b/plugin/pkg/parse/parse.go index cf4f96c09..17d2641ef 100644 --- a/plugin/pkg/parse/parse.go +++ b/plugin/pkg/parse/parse.go @@ -1,3 +1,4 @@ +// Package parse contains functions that can be used in the setup code for plugins. package parse import ( diff --git a/plugin/pkg/rcode/rcode.go b/plugin/pkg/rcode/rcode.go index 32863f0b2..d221bcbd2 100644 --- a/plugin/pkg/rcode/rcode.go +++ b/plugin/pkg/rcode/rcode.go @@ -6,8 +6,7 @@ import ( "github.com/miekg/dns" ) -// ToString convert the rcode to the official DNS string, or to "RCODE"+value if the RCODE -// value is unknown. +// ToString convert the rcode to the official DNS string, or to "RCODE"+value if the RCODE value is unknown. func ToString(rcode int) string { if str, ok := dns.RcodeToString[rcode]; ok { return str diff --git a/plugin/pkg/up/up.go b/plugin/pkg/up/up.go index 06971eef7..34b23fdad 100644 --- a/plugin/pkg/up/up.go +++ b/plugin/pkg/up/up.go @@ -1,3 +1,5 @@ +// Package up is used to run a function for some duration. If a new function is added while a previous run is +// still ongoing, nothing new will be executed. package up import ( |