diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst index 27ba23d34b80817898be29daa580346683f4878f..84a749872b858baf631366d71650d7ee4d07c19f 100644 --- a/docs/dev/basics.rst +++ b/docs/dev/basics.rst @@ -57,7 +57,7 @@ commits, making `git reflog` the only way to recover them! make refresh-patches -In order to refresh patches when updating feeds or the OpenWrt base, `make refresh-patches` applies and updates all of their patches without installing feed packages to the OpenWrt buildsystem. +In order to refresh patches when updating feeds or the OpenWrt base, `make refresh-patches` applies and updates all of their patches without installing feed packages to the OpenWrt build system. This command speeds up the maintenance of updating OpenWrt and feeds. @@ -77,7 +77,7 @@ apply: - use tabs instead of spaces - trailing whitespaces must be eliminated - files need to end with a final newline -- newlines need to have unix line endings (lf) +- newlines need to have Unix line endings (lf) To that end we provide a ``.editorconfig`` configuration, which is supported by most of the editors out there. diff --git a/docs/dev/debugging.rst b/docs/dev/debugging.rst index ca1cd04168208ff7b80e90b8411ef462932a5a2e..626cf28e6e6e8218b68a48e467f1279ff992bff4 100644 --- a/docs/dev/debugging.rst +++ b/docs/dev/debugging.rst @@ -45,7 +45,7 @@ Some more information on how to use this tool can be found at Obtaining Stacktraces ..................... -On many targets stacktraces can be read from the following +On many targets stack traces can be read from the following location after reboot: :: /sys/kernel/debug/crashlog diff --git a/docs/features/monitoring.rst b/docs/features/monitoring.rst index 2879bf73c20a372a3c688b33a51f8a47aae8754d..d88baaf5be27c498be361e452d38bbf59a860692 100644 --- a/docs/features/monitoring.rst +++ b/docs/features/monitoring.rst @@ -47,7 +47,7 @@ installed. Please note that at least one alfred daemon is required to run as .. _alfred-json: https://github.com/ffnord/alfred-json -The following datatypes are used: +The following data types are used: * `nodeinfo`: 158 * `statistics`: 159 diff --git a/docs/features/vpn.rst b/docs/features/vpn.rst index a65750c10d25b349be713f0a01a81554161e076e..6db2ecc65270bcaea1d5097bb91beb2c503cdd35 100644 --- a/docs/features/vpn.rst +++ b/docs/features/vpn.rst @@ -77,7 +77,7 @@ should always appear before ``null`` in the configuration when both are enabled. fastd v22 or newer is needed for the ``null@l2tp`` method. It is often not necessary to enable L2TP offloading on supernodes for -performance reasons. Nodes using offloading can communicate with supornodes that +performance reasons. Nodes using offloading can communicate with supernodes that don't use offloading as long as both use the ``null@l2tp`` method. @@ -107,7 +107,7 @@ However, the important changes to the fastd config on your Supernode are: Note that in ``multitap`` mode, which is required when using L2TP offloading, fastd will create one interface per peer on the supernode's. This allows offloading the L2TP forwarding into the kernel space. But this also means added -copmlexity with regards to handling those interfaces. +complexity with regards to handling those interfaces. There are two main options on how you can handle this: diff --git a/docs/releases/v2020.1.rst b/docs/releases/v2020.1.rst index bebd07c4a9f5d10c3ce18847d509c4fedd662cf3..fe62c240905f681de1c46acc6b7c5ce21201bd16 100644 --- a/docs/releases/v2020.1.rst +++ b/docs/releases/v2020.1.rst @@ -127,10 +127,10 @@ Renamed targets Status Page ~~~~~~~~~~~ -- Gateway nexthop information has been added to the statuspage when batman-adv +- Gateway nexthop information has been added to the status page when batman-adv is used. This includes its MAC address and prettyname as well as the interface name towards the selected gateway. -- The site name has been added to the statuspage. If the node is in a multidomain +- The site name has been added to the status page. If the node is in a multidomain setup it will also show the domain name. DECT button to enter config mode diff --git a/docs/releases/v2021.1.1.rst b/docs/releases/v2021.1.1.rst index 573babf5fb3a806c69d07714d248eeee5dada858..8d5e626b5d9defd2ea46e966de392489091b0299 100644 --- a/docs/releases/v2021.1.1.rst +++ b/docs/releases/v2021.1.1.rst @@ -34,7 +34,7 @@ Bugfixes - The Tunneldigger VPN provider was not registered with the Gluon VPN backend, resulting in broken Tunneldigger configurations. -- Disabling Radio interfaces in v2021.1 could lead to nullpointer dereferences in the respondd airtime module, as the survey returns no data in this case. +- Disabling Radio interfaces in v2021.1 could lead to null pointer dereferences in the respondd airtime module, as the survey returns no data in this case. Known issues