aboutsummaryrefslogtreecommitdiff
path: root/middleware
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2017-09-11 06:51:24 +0100
committerGravatar GitHub <noreply@github.com> 2017-09-11 06:51:24 +0100
commit296c5a0c1c185250c72875ccfe137afc8b6a5b63 (patch)
tree4f8b4c1ce2cd24f6a1ed16a7ac9e15419a31e8d3 /middleware
parent176e0916fef310ccaf51e8b264a419df0ef4d446 (diff)
downloadcoredns-296c5a0c1c185250c72875ccfe137afc8b6a5b63.tar.gz
coredns-296c5a0c1c185250c72875ccfe137afc8b6a5b63.tar.zst
coredns-296c5a0c1c185250c72875ccfe137afc8b6a5b63.zip
mw/errors: doc (#1057)
Remove the [FILE] option from the docs, we still allow it, but this one value that we allow now *stdout* isn't shown anymore. Also test the snippet with readme_test.go by adding `~~ corefile`.
Diffstat (limited to 'middleware')
-rw-r--r--middleware/errors/README.md21
1 files changed, 8 insertions, 13 deletions
diff --git a/middleware/errors/README.md b/middleware/errors/README.md
index 53ac5bacf..21b8f4848 100644
--- a/middleware/errors/README.md
+++ b/middleware/errors/README.md
@@ -2,26 +2,21 @@
*errors* enables error logging.
-Any errors encountered during the query processing will be printed on standard output.
+Any errors encountered during the query processing will be printed to standard output.
## Syntax
~~~
-errors [FILE]
+errors
~~~
-* **FILE** is the log file to create (or append to). The *only* valid name for **FILE** is *stdout*
-
## Examples
-Log errors to *stdout*.
-
-~~~
-errors
-~~~
-
-Log errors to *stdout*.
+Use the *whoami* to respond to queries and Log errors to standard output.
-~~~
-errors stdout
+~~~ corefile
+. {
+ whoami
+ errors
+}
~~~