aboutsummaryrefslogtreecommitdiff
path: root/plugin
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2020-01-31 12:37:24 +0100
committerGravatar GitHub <noreply@github.com> 2020-01-31 11:37:24 +0000
commitf77c6e55bf735ab3e08feaa8dbbf4a995512a992 (patch)
tree4673f537d44dc33d3ad8645dd5963cf2536605de /plugin
parent510f2c503da2d8a428c656f5240481b2f2f4b718 (diff)
downloadcoredns-f77c6e55bf735ab3e08feaa8dbbf4a995512a992.tar.gz
coredns-f77c6e55bf735ab3e08feaa8dbbf4a995512a992.tar.zst
coredns-f77c6e55bf735ab3e08feaa8dbbf4a995512a992.zip
presubmit: test README.md sections (#3644)
Automatically submitted.
Diffstat (limited to 'plugin')
-rw-r--r--plugin/cancel/README.md2
-rw-r--r--plugin/k8s_external/README.md2
-rw-r--r--plugin/rewrite/README.md2
-rw-r--r--plugin/secondary/README.md2
-rw-r--r--plugin/transfer/README.md4
5 files changed, 11 insertions, 1 deletions
diff --git a/plugin/cancel/README.md b/plugin/cancel/README.md
index 8561b1f6b..65224bf52 100644
--- a/plugin/cancel/README.md
+++ b/plugin/cancel/README.md
@@ -16,6 +16,8 @@ A plugin interested in the cancellation status should call `plugin.Done()` on th
context was canceled due to a timeout the plugin should not write anything back to the client and
return a value indicating CoreDNS should not either; a zero return value should suffice for that.
+## Syntax
+
~~~ txt
cancel [TIMEOUT]
~~~
diff --git a/plugin/k8s_external/README.md b/plugin/k8s_external/README.md
index dc251ab02..9fded952a 100644
--- a/plugin/k8s_external/README.md
+++ b/plugin/k8s_external/README.md
@@ -57,7 +57,7 @@ k8s_external [ZONE...] {
* **APEX** is the name (DNS label) to use for the apex records; it defaults to `dns`.
* `ttl` allows you to set a custom **TTL** for responses. The default is 5 (seconds).
-# Examples
+## Examples
Enable names under `example.org` to be resolved to in-cluster DNS addresses.
diff --git a/plugin/rewrite/README.md b/plugin/rewrite/README.md
index 601bf0447..ca48a6d17 100644
--- a/plugin/rewrite/README.md
+++ b/plugin/rewrite/README.md
@@ -37,6 +37,8 @@ will behave as follows:
* `continue` will continue applying the next rule in the rule list.
* `stop` will consider the current rule the last rule and will not continue. The default behaviour is `stop`
+## Examples
+
### Name Field Rewrites
The `rewrite` plugin offers the ability to match the name in the question section of
diff --git a/plugin/secondary/README.md b/plugin/secondary/README.md
index 00a9d6b88..dab740284 100644
--- a/plugin/secondary/README.md
+++ b/plugin/secondary/README.md
@@ -10,6 +10,8 @@ With *secondary* you can transfer (via AXFR) a zone from another server. The ret
*not committed* to disk (a violation of the RFC). This means restarting CoreDNS will cause it to
retrieve all secondary zones.
+## Syntax
+
~~~
secondary [ZONES...]
~~~
diff --git a/plugin/transfer/README.md b/plugin/transfer/README.md
index 45ec60c99..fdd4467d2 100644
--- a/plugin/transfer/README.md
+++ b/plugin/transfer/README.md
@@ -29,3 +29,7 @@ transfer [ZONE...] {
* `to ` **HOST...** The hosts *transfer* will transfer to. Use `*` to permit
transfers to all hosts.
+
+## Examples
+
+TODO