]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: misc tiny fixes
authorVladimír Čunát <vladimir.cunat@nic.cz>
Fri, 3 May 2024 09:07:22 +0000 (11:07 +0200)
committerVladimír Čunát <vladimir.cunat@nic.cz>
Thu, 24 Apr 2025 08:36:05 +0000 (10:36 +0200)
doc/dev/config-lua-performance.rst
doc/user/config-multiple-workers.rst
doc/user/config-network-server-tls.rst
doc/user/config-network-server.rst
doc/user/config-overview.rst
doc/user/config-performance.rst
doc/user/gettingstarted-config.rst
doc/user/gettingstarted-startup.rst
doc/user/manager-api.rst

index 5f273a71f0686c7ec47fdf025f812394b8d6be92..bbc138c1f8679bc3bf85d150f83aa6d559906b56 100644 (file)
@@ -10,16 +10,16 @@ For DNS resolvers, the most important parameter from performance perspective
 is cache hit rate, i.e. percentage of queries answered from resolver's cache.
 Generally the higher cache hit rate the better.
 
-Performance tunning should start with cache :ref:`cache_sizing`
+Performance tuning should start with cache :ref:`cache_sizing`
 and :ref:`cache_persistence`.
 
 It is also recommended to run :ref:`systemd-multiple-instances` (even on a
 single machine!) because it allows to utilize multiple CPU threads and
 increases overall resiliency.
 
-Other features described in this section can be used for fine-tunning
+Other features described in this section can be used for fine-tuning
 performance and resiliency of the resolver but generally have much smaller
-impact than cache settings and number of instances.
+impact than cache settings and number of workers.
 
 .. toctree::
    :maxdepth: 1
index b31e9e18e9e522632437c01c7f88f0279c065356..4448692e7b335a1928b55c091214d2721d489e84 100644 (file)
@@ -6,7 +6,7 @@ Multiple workers
 ================
 
 Knot Resolver can utilize multiple CPUs running multiple independent workers (processes), where each process utilizes at most single CPU core on your machine.
-If your machine handles a lot of DNS traffic configure multiple workers.
+If your machine handles a lot of DNS traffic, configure multiple workers.
 
 All workers typically share the same configuration and cache, and incoming queries are automatically distributed by operating system among all workers.
 
@@ -23,7 +23,7 @@ To run multiple workers, configure its number in configuration file.
    workers: 4
 
 You can try let the resolver get number of available CPU threads automatically.
-If there is problem, configuration shoul not pass validation process.
+If there is a problem, configuration should not pass the validation process.
 
 .. code-block:: yaml
 
index ea63482f736c9d5f13fafffa6011b417e902156f..abc4429afc8fc846a0d46e9a28c6818dc5b14903 100644 (file)
@@ -70,8 +70,6 @@ The additional considerations for TLS 1.2 required by HTTP/2 are not implemented
    If an unrelated HTTPS service is running on the same port with REUSEPORT enabled, you will end up with both services malfunctioning.
 
 
-.. _dot-doh-config-options:
-
 HTTP status codes
 """""""""""""""""
 
@@ -95,6 +93,8 @@ the following status codes:
    ``GET``, ``POST``, or ``HEAD``
 
 
+.. _dot-doh-config-options:
+
 Configuration options for DoT and DoH
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
index e6db04fef8fa689a5c03a68f2d16843403d4a7b6..0d1806efce3385f74f4d3d3f62c2cc9c56c6406d 100644 (file)
@@ -23,7 +23,7 @@ address + port combination.
    :header: "Protocol/service", :option:`kind <kind: dns|xdp|dot|doh2|doh-legacy>`
 
    "DNS (unencrypted UDP+TCP, :rfc:`1034`)","``dns``"
-   "DNS (unencrypted UDP, `using XDP Linux API <./dev/daemon-bindings-net_server.html#dns-over-xdp>`_)","``xdp``"
+   "DNS (unencrypted UDP, `using XDP Linux API <./dev/daemon-bindings-net_xdpsrv.html#dns-over-xdp>`_)","``xdp``"
    ":ref:`dns-over-tls`","``dot``"
    ":ref:`dns-over-https`","``doh2``"
    "`Legacy DNS-over-HTTPS (DoH) <./dev/modules-http.html#mod-http-doh>`_","``doh-legacy``"
index b42ee0a39ec790c7202dd235e3564f88d8bbd132..a047c60f344efa0db22df5fe74a123b457c57ed4 100644 (file)
@@ -38,7 +38,7 @@ You can use :ref:`kresctl validate <manager-client>` to check your configuration
                 [/management/interface] invalid port number 66000
                 [/logging/level] 'noticed' does not match any of the expected values ('crit', 'err', 'warning', 'notice', 'info', 'debug')
 
-    If you happen to find a rejected configuration with unhelpful or confusing error message, please report it as a bug.
+    If you happen to find a rejected configuration with an unhelpful or confusing error message, please report it as a bug.
 
 
 JSON Schema
index 43b15c5389387151960f90060c7a0c7aa76a19ab..1d3604d8cec7dc730d42caa73ab310c27ecaf6f7 100644 (file)
@@ -10,16 +10,16 @@ For DNS resolvers, the most important parameter from performance perspective
 is cache hit rate, i.e. percentage of queries answered from resolver's cache.
 Generally the higher cache hit rate the better.
 
-Performance tunning should start with cache :ref:`config-cache-sizing`
+Performance tuning should start with cache :ref:`config-cache-sizing`
 and :ref:`config-cache-persistence`.
 
 .. It is also recommended to run :ref:`systemd-multiple-instances` (even on a
 .. single machine!) because it allows to utilize multiple CPU threads and
 .. increases overall resiliency.
 
-Other features described in this section can be used for fine-tunning
+Other features described in this section can be used for fine-tuning
 performance and resiliency of the resolver but generally have much smaller
-impact than cache settings and number of instances.
+impact than cache settings and number of workers.
 
 .. toctree::
    :maxdepth: 1
index bc3aab5a861e5e035b816ed4f63dbecf04fb253c..d9f94ea7af3efbd2b3f174db656fb60fe4701088 100644 (file)
@@ -15,7 +15,7 @@ You can start exploring the configuration by reading further in this chapter, or
    :local:
 
 Complete example configuration files can be found `in Knot Resolver's source repository <https://gitlab.nic.cz/knot/knot-resolver/tree/master/etc/config>`_.
-Examples are also installed as documentation files, typically in the ``/usr/share/doc/knot-resolver/examples/`` directory (the location may differ based on your Linux distribution).
+Examples are also installed as documentation files, typically in the ``/usr/share/doc/knot-resolver*/examples/`` directory (the location may differ based on your Linux distribution).
 
 .. tip::
 
index e24b5c05b5217bbb5f63d3f4a715797ace1d3873..d0d3c49717c341ec4a428ca1ec19d253f4ec2fd5 100644 (file)
@@ -19,12 +19,12 @@ See logs and status of running instance with ``systemctl status knot-resolver.se
     ``knot-resolver.service`` may not be enabled by default after installation, thus Knot Resolver might not start automatically after reboot.
     To start and enable service in one command use ``systemctl enable --now knot-resolver.service``
 
-Unfortunately, for some cases (typically Docker and minimalistic systems), ``systemd`` is not available, therefore it is not possible to use ``knot-resolver.service``.
+Unfortunately, for some cases (typically Docker, minimalistic and non-Linux systems), ``systemd`` is not available, therefore it is not possible to use ``knot-resolver.service``.
 If you have this problem, look at :ref:`usage without systemd <deployment-no-systemd>` section.
 
 .. note::
 
-    If for some reason you need to use Knot Resolver as it was before version 6, check out :ref:`usage without the manager <advanced-no-manager>`
+    If for some reason you need to use Knot Resolver as it was before version 6, check out :ref:`usage without the manager <advanced-no-manager>`.
     Otherwise, it is recommended to stick to this chapter.
 
 ===============
index db7754e6f84b5b5686ff9dfaa29a0857506e7776..961001366c539a141d898b26e5a9f60d89109fa3 100644 (file)
@@ -37,7 +37,7 @@ HTTP request methods               Operation
 
 .. note::
 
-    Managemnet API has other useful endpoints (metrics, schema, ...), see the detailed :ref:`API documentation <manager-api>`.
+    Management API has other useful endpoints (metrics, schema, ...), see the detailed :ref:`API documentation <manager-api>`.
 
 **path:**
     Determines specific configuration option or configuration subtree on that path.
@@ -48,7 +48,7 @@ HTTP request methods               Operation
 
 .. note::
 
-    Some configuration options cannot be configured via the API for stability and security reasons(e.g. API configuration itself).
+    Some configuration options cannot be configured via the API for stability and security reasons (e.g. API configuration itself).
     In the case of an attempt to configure such an option, the operation is rejected.
 
 
@@ -61,7 +61,7 @@ HTTP request methods               Operation
 Dynamically changing configuration
 ===================================
 
-Knot Resolver Manager is capable of dynamically changing its configuration via an HTTP API or by reloading its config file. Both methods are equivalent in terms of its capabilities. The ``kresctl`` utility uses the HTTP API and provides a convinient command line interface.
+Knot Resolver Manager is capable of dynamically changing its configuration via an HTTP API or by reloading its config file. Both methods are equivalent in terms of its capabilities. The ``kresctl`` utility uses the HTTP API and provides a convenient command line interface.
 
 Reloading configuration file
 ============================