TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 4 Projects Releases Packages Wiki Activity Actions

plugin/reload: reflow documentation (#3313)

Browse source 
* plugin/reload: reflow documentation

For some reason these we're all bullets points, which made for awkward
reading.

Signed-off-by: Miek Gieben <miek@miek.nl>

* typo

Signed-off-by: Miek Gieben <miek@miek.nl>

* Update plugin/reload/README.md

Co-Authored-By: Michael Grosser <development@stp-ip.net>
This commit is contained in:
Miek Gieben 2019-09-27 11:10:47 +01:00 • committed by GitHub
parent 8af4685587
commit 7328d3e8c9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
plugin/reload/README.md
View file

@ -38,11 +38,12 @@ This plugin can only be used once per Server Block.
reload [INTERVAL] [JITTER] reload [INTERVAL] [JITTER]
~~~ ~~~
* The plugin will check for changes every **INTERVAL**, subject to +/- the **JITTER** duration The plugin will check for changes every **INTERVAL**, subject to +/- the **JITTER** duration.
* **INTERVAL** and **JITTER** are Golang (durations)[https://golang.org/pkg/time/#ParseDuration]
* Default **INTERVAL** is 30s, default **JITTER** is 15s * **INTERVAL** and **JITTER** are Golang (durations)[[https://golang.org/pkg/time/#ParseDuration](https://golang.org/pkg/time/#ParseDuration)].
* Minimal value for **INTERVAL** is 2s, and for **JITTER** is 1s The default **INTERVAL** is 30s, default **JITTER** is 15s, the minimal value for **INTERVAL**
* If **JITTER** is more than half of **INTERVAL**, it will be set to half of **INTERVAL** is 2s, and for **JITTER** it is 1s. If **JITTER** is more than half of **INTERVAL**, it will be
set to half of **INTERVAL**
## Examples ## Examples

2
plugin/reload/reload.go
View file

@ -1,3 +1,4 @@
// Package reload periodically checks if the Corefile has changed, and reloads if so.
package reload package reload
import ( import (
@ -11,7 +12,6 @@ import (
"github.com/caddyserver/caddy/caddyfile" "github.com/caddyserver/caddy/caddyfile"
) )
// reload periodically checks if the Corefile has changed, and reloads if so
const ( const (
unused = 0 unused = 0
maybeUsed = 1 maybeUsed = 1