From: Vladimír Čunát <vladimir.cunat@nic.cz>
Date: Tue, 3 Oct 2023 11:04:47 +0000 (+0200)
Subject: doc/config-network-server: begin with typical examples
X-Git-Tag: v6.0.5~9^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8d451a836eeb39ec8f9fd3e79e6947ba69e22c7e;p=thirdparty%2Fknot-resolver.git

doc/config-network-server: begin with typical examples

Spacing around brackets seems more common in our examples.
---

diff --git a/doc/config-network-server.rst b/doc/config-network-server.rst
index 9cbfc9de2..469582df0 100644
--- a/doc/config-network-server.rst
+++ b/doc/config-network-server.rst
@@ -6,6 +6,16 @@ Addresses and services
 Addresses, ports, protocols, and API calls available for clients communicating
 with the resolver are configured in :option:`network/listen <network/listen: <list>>`.
 
+.. code-block:: yaml
+
+   network: # typical examples
+     listen:
+       - interface: lo # plain DNS on localhost, port 53
+       - interface: eth0
+         kind: dot
+       - interface: [ 127.0.0.1, '::1' ]
+         kind: doh2
+
 First, you need to decide what type of service should be available on a given IP
 address + port combination.
 
@@ -54,15 +64,10 @@ address + port combination.
 
 .. code-block:: yaml
 
-   network:
+   network: # some unusual examples
      listen:
-       - interface: '::1'  # default port is 53
-       - interface: lo
+       - interface: '::1'
          port: 3535
-       - interface: eth0
-         kind: dot  # default port is 853
-       - interface: [127.0.0.1, '::1']
-         kind: doh2  # default port is 443
        - interface: eth0
          port: 5353  # custom port number, default is 53 for XDP
          kind: xdp