aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2017-07-24 08:24:53 -0700
committerGravatar GitHub <noreply@github.com> 2017-07-24 08:24:53 -0700
commitf33b02689c564c1de8774f7f99d2400231a76069 (patch)
tree868c84db6dc13a3e463882d3856fbb3e77b0d545
parent1e6f13478313cb958e2057ef812e19a7bbd0e0a9 (diff)
downloadcoredns-f33b02689c564c1de8774f7f99d2400231a76069.tar.gz
coredns-f33b02689c564c1de8774f7f99d2400231a76069.tar.zst
coredns-f33b02689c564c1de8774f7f99d2400231a76069.zip
Fix all READMEs and some other fluff (#788)
-rw-r--r--Makefile.release2
-rw-r--r--middleware/bind/README.md7
-rw-r--r--middleware/chaos/README.md1
-rw-r--r--middleware/debug/README.md4
-rw-r--r--middleware/erratic/README.md6
-rw-r--r--middleware/errors/README.md3
-rw-r--r--middleware/hosts/README.md2
-rw-r--r--middleware/loadbalance/README.md10
-rw-r--r--middleware/metrics/README.md4
-rw-r--r--middleware/pprof/README.md7
-rw-r--r--middleware/proxy/README.md9
-rw-r--r--middleware/rewrite/README.md7
-rw-r--r--middleware/root/README.md5
13 files changed, 35 insertions, 32 deletions
diff --git a/Makefile.release b/Makefile.release
index 9b47840f5..58e356aed 100644
--- a/Makefile.release
+++ b/Makefile.release
@@ -31,7 +31,7 @@
# Steps for docker
# * Login into docker: docker login (should have push creds for coredns registry)
# * Run: make -f Makefile.release docker
-#
+#
# Docker push should happen after you make the new release and uploaded it to Github.
NAME:=coredns
diff --git a/middleware/bind/README.md b/middleware/bind/README.md
index 98be903a2..57b3c1e18 100644
--- a/middleware/bind/README.md
+++ b/middleware/bind/README.md
@@ -1,8 +1,9 @@
# bind
-*bind* overrides the host to which the server should bind. Normally, the listener binds to the
-wildcard host. However, you may force the listener to bind to another IP instead. This
-directive accepts only an address, not a port.
+*bind* overrides the host to which the server should bind.
+
+Normally, the listener binds to the wildcard host. However, you may force the listener to bind to
+another IP instead. This directive accepts only an address, not a port.
## Syntax
diff --git a/middleware/chaos/README.md b/middleware/chaos/README.md
index e03af7d00..d3c571e1f 100644
--- a/middleware/chaos/README.md
+++ b/middleware/chaos/README.md
@@ -1,6 +1,7 @@
# chaos
The *chaos* middleware allows CoreDNS to respond to TXT queries in the CH class.
+
This is useful for retrieving version or author information from the server.
## Syntax
diff --git a/middleware/debug/README.md b/middleware/debug/README.md
index b74d95612..cae6d0ff8 100644
--- a/middleware/debug/README.md
+++ b/middleware/debug/README.md
@@ -1,7 +1,7 @@
# debug
-*debug* disables the automatic recovery upon a CoreDNS crash so that you'll get a
-nice stack trace.
+*debug* disables the automatic recovery upon a CoreDNS crash so that you'll get a nice stack trace.
+
Note that the *errors* middleware (if loaded) will also set a `recover` negating this setting.
The main use of *debug* is to help testing.
diff --git a/middleware/erratic/README.md b/middleware/erratic/README.md
index 5407c9a7b..e2989da96 100644
--- a/middleware/erratic/README.md
+++ b/middleware/erratic/README.md
@@ -1,11 +1,7 @@
# erratic
*erratic* is a middleware useful for testing client behavior. It returns a static response to all
-queries, but the responses can be:
-
-* delayed by some duration
-* dropped all together
-* the truncated bit can be set
+queries, but the responses can be delayed, dropped or truncated.
The *erratic* middleware will respond to every A or AAAA query. For any other type it will return
a SERVFAIL response. The reply for A will return 192.0.2.53 (see RFC 5737), for AAAA it returns
diff --git a/middleware/errors/README.md b/middleware/errors/README.md
index 461cdfec8..53ac5bacf 100644
--- a/middleware/errors/README.md
+++ b/middleware/errors/README.md
@@ -1,7 +1,8 @@
# errors
*errors* enables error logging.
-TODO: what are errors.
+
+Any errors encountered during the query processing will be printed on standard output.
## Syntax
diff --git a/middleware/hosts/README.md b/middleware/hosts/README.md
index 8fd08dfaa..91d340cb5 100644
--- a/middleware/hosts/README.md
+++ b/middleware/hosts/README.md
@@ -1,6 +1,6 @@
# hosts
-*hosts* enables serving zone data from a /etc/hosts style file.
+*hosts* enables serving zone data from a `/etc/hosts` style file.
The hosts middleware is useful for serving zones from a /etc/hosts file. It serves from a preloaded
file that exists on disk. It checks the file for changes and updates the zones accordingly. This
diff --git a/middleware/loadbalance/README.md b/middleware/loadbalance/README.md
index cb5afc1da..1cce54ebf 100644
--- a/middleware/loadbalance/README.md
+++ b/middleware/loadbalance/README.md
@@ -1,11 +1,11 @@
# loadbalance
*loadbalance* acts as a round-robin DNS loadbalancer by randomizing the order of A and AAAA records
- in the answer. See [Wikipedia](https://en.wikipedia.org/wiki/Round-robin_DNS) about the pros and
- cons on this setup.
-
-It will take care to sort any CNAMEs before any address records, because some stub resolver
-implementations (like glibc) are particular about that.
+ in the answer.
+
+ See [Wikipedia](https://en.wikipedia.org/wiki/Round-robin_DNS) about the pros and cons on this
+ setup. It will take care to sort any CNAMEs before any address records, because some stub resolver
+ implementations (like glibc) are particular about that.
## Syntax
diff --git a/middleware/metrics/README.md b/middleware/metrics/README.md
index a5d5bc8dc..a1ab52b88 100644
--- a/middleware/metrics/README.md
+++ b/middleware/metrics/README.md
@@ -1,8 +1,8 @@
# prometheus
-This module enables prometheus metrics for CoreDNS. The default location for the metrics is
-`localhost:9153`. The metrics path is fixed to `/metrics`.
+This module enables prometheus metrics for CoreDNS.
+The default location for the metrics is `localhost:9153`. The metrics path is fixed to `/metrics`.
The following metrics are exported:
* coredns_dns_request_count_total{zone, proto, family}
diff --git a/middleware/pprof/README.md b/middleware/pprof/README.md
index b1a5f12c4..06a36e442 100644
--- a/middleware/pprof/README.md
+++ b/middleware/pprof/README.md
@@ -1,8 +1,9 @@
# pprof
-*pprof* publishes runtime profiling data at endpoints under /debug/pprof. You can visit
- `/debug/pprof`
-on your site for an index of the available endpoints. By default it will listen on localhost:6053.
+*pprof* publishes runtime profiling data at endpoints under /debug/pprof.
+
+You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it
+will listen on localhost:6053.
> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
> you use pprof on a live site, consider restricting access or enabling it only temporarily.
diff --git a/middleware/proxy/README.md b/middleware/proxy/README.md
index 532a9cace..492a1e50c 100644
--- a/middleware/proxy/README.md
+++ b/middleware/proxy/README.md
@@ -1,9 +1,10 @@
# proxy
-*proxy* facilitates both a basic reverse proxy and a robust load balancer. The proxy has support for
- multiple backends. The load balancing features include multiple policies, health checks, and
- failovers. If all hosts fail their health check the proxy middleware will fail back to randomly
- selecting a target and sending packets to it.
+*proxy* facilitates both a basic reverse proxy and a robust load balancer.
+
+The proxy has support for multiple backends. The load balancing features include multiple policies,
+health checks, and failovers. If all hosts fail their health check the proxy middleware will fail
+back to randomly selecting a target and sending packets to it.
## Syntax
diff --git a/middleware/rewrite/README.md b/middleware/rewrite/README.md
index 3d0c6c321..0ab1e1a1d 100644
--- a/middleware/rewrite/README.md
+++ b/middleware/rewrite/README.md
@@ -1,8 +1,9 @@
# rewrite
-*rewrite* performs internal message rewriting. Rewrites are invisible to the client.
-There are simple rewrites (fast) and complex rewrites (slower), but they're powerful enough to
-accommodate most dynamic back-end applications.
+*rewrite* performs internal message rewriting.
+
+Rewrites are invisible to the client. There are simple rewrites (fast) and complex rewrites
+(slower), but they're powerful enough to accommodate most dynamic back-end applications.
## Syntax
diff --git a/middleware/root/README.md b/middleware/root/README.md
index 5d09a31f3..23d35b2d3 100644
--- a/middleware/root/README.md
+++ b/middleware/root/README.md
@@ -1,8 +1,9 @@
# root
*root* simply specifies the root of where CoreDNS finds (e.g.) zone files.
-The default root is the current working directory of CoreDNS.
-A relative root path is relative to the current working directory.
+
+The default root is the current working directory of CoreDNS. A relative root path is relative to
+the current working directory.
## Syntax