From c5520a52956840e603e3cbbd97785d6626ac609e Mon Sep 17 00:00:00 2001
From: Bob Idle <102661087+bobidle@users.noreply.github.com>
Date: Wed, 18 Oct 2023 18:45:26 +0200
Subject: [PATCH] docs: fix typos, change letter case and remove whitespace
characters
---
docs/dev/basics.rst | 6 +++---
docs/dev/hardware.rst | 2 +-
docs/dev/packages.rst | 2 +-
docs/dev/web/model.rst | 2 +-
docs/features/vpn.rst | 2 +-
docs/package/gluon-web-admin.rst | 2 +-
docs/releases/v2014.4.rst | 2 +-
docs/releases/v2016.2.rst | 4 ++--
docs/releases/v2018.2.4.rst | 4 ++--
docs/releases/v2018.2.rst | 2 +-
docs/releases/v2019.1.1.rst | 2 +-
docs/releases/v2020.1.rst | 4 ++--
docs/releases/v2022.1.4.rst | 18 +++++++++---------
docs/user/faq.rst | 2 +-
docs/user/getting_started.rst | 2 +-
docs/user/mtu.rst | 20 ++++++++++----------
docs/user/site.rst | 6 +++---
docs/user/supported_devices.rst | 6 +++---
18 files changed, 44 insertions(+), 44 deletions(-)
diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst
index 84a749872..dd748a2bb 100644
--- a/docs/dev/basics.rst
+++ b/docs/dev/basics.rst
@@ -8,7 +8,7 @@ Gluon's source is kept in `git repositories`_ at GitHub.
Bug Tracker
-----------
-The `main repo`_ does have issues enabled.
+The `main repo`_ does have issues enabled.
.. _main repo: https://github.com/freifunk-gluon/gluon
@@ -17,7 +17,7 @@ IRC
Gluon's developers frequent the IRC chatroom `#gluon`_ on `hackint`_.
There is a `webchat`_ that allows for easy access from within your
-webbrowser. You're welcome to join us!
+web browser. You're welcome to join us!
.. _#gluon: ircs://irc.hackint.org/#gluon
.. _hackint: https://hackint.org/
@@ -75,7 +75,7 @@ the code in the project is formatted in the same way. The following basic rules
apply:
- use tabs instead of spaces
-- trailing whitespaces must be eliminated
+- trailing whitespace characters must be eliminated
- files need to end with a final newline
- newlines need to have Unix line endings (lf)
diff --git a/docs/dev/hardware.rst b/docs/dev/hardware.rst
index fb56d08f1..7db1cc07f 100644
--- a/docs/dev/hardware.rst
+++ b/docs/dev/hardware.rst
@@ -118,7 +118,7 @@ image output directory.
aliases = {'aruba-instant-on-ap11'},
})
-The aliased name will also be added to the autoupdate manifest, allowing upgrade
+The aliased name will also be added to the autoupdater manifest, allowing upgrade
images to be found under the different name on targets that perform model name
detection at runtime.
diff --git a/docs/dev/packages.rst b/docs/dev/packages.rst
index 7c239675b..5bd1f0e33 100644
--- a/docs/dev/packages.rst
+++ b/docs/dev/packages.rst
@@ -60,7 +60,7 @@ Features of ``push_pkg.sh``:
* Works with native OpenWrt and Gluon packages.
* Pushes to remote machines or local qemu instances.
-* Pushes multiple packages in in one call if desired.
+* Pushes multiple packages in one call if desired.
* Performs site.conf checks.
Implementation details of ``push_pkg.sh``:
diff --git a/docs/dev/web/model.rst b/docs/dev/web/model.rst
index d53356902..8c924b9ee 100644
--- a/docs/dev/web/model.rst
+++ b/docs/dev/web/model.rst
@@ -26,7 +26,7 @@ Let's start with an example:
return f
-The toplevel element of a model is always a *Form*, but it is also possible for
+The top-level element of a model is always a *Form*, but it is also possible for
a model to return multiple forms, which are displayed one below the other.
A *Form* has one or more *Sections*, and each *Section* has different types
diff --git a/docs/features/vpn.rst b/docs/features/vpn.rst
index 52bb65fcf..7a5ba7748 100644
--- a/docs/features/vpn.rst
+++ b/docs/features/vpn.rst
@@ -86,7 +86,7 @@ don't use offloading as long as both use the ``null@l2tp`` method.
Offloading on Gateways / Supernodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To enable L2TP offloading on the supornodes, it is recommended to study the
+To enable L2TP offloading on the supernodes, it is recommended to study the
fastd documentation section pertaining to the `offload configuration option
<https://fastd.readthedocs.io/en/stable/manual/config.html#option-offload>`_.
diff --git a/docs/package/gluon-web-admin.rst b/docs/package/gluon-web-admin.rst
index 95affa0b2..572d51157 100644
--- a/docs/package/gluon-web-admin.rst
+++ b/docs/package/gluon-web-admin.rst
@@ -13,7 +13,7 @@ config_mode.remote_login.show_password_form \: optional
- ``true`` the password section in config mode is shown
- ``false`` the password section in config mode is hidden
- defaults to ``false``
-
+
config_mode.remote_login.min_password_length \: optional
- sets the minimum allowed password length. Set this to ``1`` to disable the
length check.
diff --git a/docs/releases/v2014.4.rst b/docs/releases/v2014.4.rst
index 95937d325..71d05f5fb 100644
--- a/docs/releases/v2014.4.rst
+++ b/docs/releases/v2014.4.rst
@@ -146,7 +146,7 @@ Ignored tx-power offset on Ubiquiti AirMax devices
https://github.com/freifunk-gluon/gluon/issues/94
-There is still no OpenWRT support for determining the transmission
+There is still no OpenWrt support for determining the transmission
power offsets on Ubiquiti AirMax devices (Bullet M2, Picostation
M2, Nanostation (loco) M2, ...). Use Gluon with caution on these
devices! Manual adjustment may be required.
diff --git a/docs/releases/v2016.2.rst b/docs/releases/v2016.2.rst
index 5549ee2d8..45333e296 100644
--- a/docs/releases/v2016.2.rst
+++ b/docs/releases/v2016.2.rst
@@ -46,12 +46,12 @@ ar71xx-generic
brcm2708-bcm2708
^^^^^^^^^^^^^^^^
-* RaspberryPi 1
+* Raspberry Pi 1
brcm2708-bcm2709
^^^^^^^^^^^^^^^^
-* RaspberryPi 2
+* Raspberry Pi 2
New features
~~~~~~~~~~~~
diff --git a/docs/releases/v2018.2.4.rst b/docs/releases/v2018.2.4.rst
index bddae46d4..0af60a3a6 100644
--- a/docs/releases/v2018.2.4.rst
+++ b/docs/releases/v2018.2.4.rst
@@ -12,7 +12,7 @@ Bugfixes
* Fixes device alias for Ubiquiti UniFi AC LR. (`#1834 <https://github.com/freifunk-gluon/gluon/issues/1834>`_)
Autoupdates on this model were impossible before, since we were missing the proper device alias.
-* Add correct ath10k firmware package for OCEDO Koala. (`#1838 <https://github.com/freifunk-gluon/gluon/pull/1838>`_)
+* Add correct ath10k firmware package for Ocedo Koala. (`#1838 <https://github.com/freifunk-gluon/gluon/pull/1838>`_)
* Fixes various batman-adv bugs with backports from 2019.4 and 2019.5 by updating the openwrt-routing packages feed
@@ -20,7 +20,7 @@ Other changes
~~~~~~~~~~~~~
* Linux kernel has been updated to either
-
+
- 4.9.207 (ar71xx, brcm2708, mpc85xx) or
- 4.14.160 (ipq40xx, ipq806x, mvebu, ramips, sunxi, x86).
diff --git a/docs/releases/v2018.2.rst b/docs/releases/v2018.2.rst
index e365c9534..0080d74f4 100644
--- a/docs/releases/v2018.2.rst
+++ b/docs/releases/v2018.2.rst
@@ -18,7 +18,7 @@ ar71xx-generic
- Fritz!WLAN Repeater 450E
-* OCEDO
+* Ocedo
- Koala
diff --git a/docs/releases/v2019.1.1.rst b/docs/releases/v2019.1.1.rst
index 024d5ad66..d9bf3f41c 100644
--- a/docs/releases/v2019.1.1.rst
+++ b/docs/releases/v2019.1.1.rst
@@ -7,7 +7,7 @@ Bugfixes
* Fixes device alias for Ubiquiti UniFi AC LR. (`#1834 <https://github.com/freifunk-gluon/gluon/issues/1834>`_)
Autoupdates on this model were impossible before, since we were missing the proper device alias.
-* Add correct ath10k firmware package for OCEDO Koala. (`#1838 <https://github.com/freifunk-gluon/gluon/pull/1838>`_)
+* Add correct ath10k firmware package for Ocedo Koala. (`#1838 <https://github.com/freifunk-gluon/gluon/pull/1838>`_)
* Fixes various batman-adv bugs with backports from 2019.4 and 2019.5 by updating the openwrt-routing packages feed.
diff --git a/docs/releases/v2020.1.rst b/docs/releases/v2020.1.rst
index fe62c2409..e0ba71aca 100644
--- a/docs/releases/v2020.1.rst
+++ b/docs/releases/v2020.1.rst
@@ -18,7 +18,7 @@ ath79-generic
- devolo WiFi pro 1750i
- devolo WiFi pro 1750x
- GL.iNet GL-AR300M-Lite
-- OCEDO Raccoon
+- Ocedo Raccoon
- TP-Link Archer C6 v2
ipq40xx-generic
@@ -53,7 +53,7 @@ mpc85xx-p1020
~~~~~~~~~~~~~
- Enterasys WS-AP3710i
-- OCEDO Panda
+- Ocedo Panda
ramips-mt7620
~~~~~~~~~~~~~
diff --git a/docs/releases/v2022.1.4.rst b/docs/releases/v2022.1.4.rst
index 5d6320493..2e17ca8de 100644
--- a/docs/releases/v2022.1.4.rst
+++ b/docs/releases/v2022.1.4.rst
@@ -26,7 +26,7 @@ ath79-nand
- NETGEAR
- WNDR4300 (v1)
-
+
lantiq-xrx200
~~~~~~~~~~~~~
@@ -50,7 +50,7 @@ ramips-mt7621
- GL.iNet
- GL-MT1300
-
+
- Mercusys
- MR70X (v1)
@@ -58,15 +58,15 @@ ramips-mt7621
- Xiaomi
- Mi Router 3G
-
-
+
+
ramips-mt76x8
~~~~~~~~~~~~~
- TP-Link
- RE200 (v3)
-
+
realtek-rtl838x
~~~~~~~~~~~~~~~
@@ -74,16 +74,16 @@ realtek-rtl838x
- D-Link
- DGS-1210-10P
-
+
ipq40xx-generic
~~~~~~~~~~~~~~~
- AVM
- - FRITZBox 7520
-
-
+ - FRITZ!Box 7520
+
+
ipq40xx-mikrotik
~~~~~~~~~~~~~~~~
diff --git a/docs/user/faq.rst b/docs/user/faq.rst
index ecdf79879..332a9ae0b 100644
--- a/docs/user/faq.rst
+++ b/docs/user/faq.rst
@@ -6,7 +6,7 @@ Frequently Asked Questions
What hardware is supported?
~~~~~~~~~~~~~~~~~~~~~~~~~~~
A table with hardware supported by Gluon can be found on the `OpenWrt Wiki`_.
-If you want to find out if your device can potentially be supported
+If you want to find out if your device can potentially be supported
have a look at :doc:`../dev/hardware` for detailed hardware requirements.
.. _OpenWrt Wiki: https://openwrt.org/toh/views/toh_gluon_supported
diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst
index 714c62738..f8652d317 100644
--- a/docs/user/getting_started.rst
+++ b/docs/user/getting_started.rst
@@ -246,7 +246,7 @@ Special variables
GLUON_AUTOREMOVE
Setting ``GLUON_AUTOREMOVE=1`` enables the ``CONFIG_AUTOREMOVE`` OpenWrt setting, which will delete package build
directories after a package build has finished to save space. This is mostly useful for CI builds from scratch. Do
- not set this flag during development (or generally, when you want you reuse your build tree for subsequent builds),
+ not set this flag during development (or generally, when you want to reuse your build tree for subsequent builds),
as it significantly increases incremental build times.
GLUON_DEBUG
diff --git a/docs/user/mtu.rst b/docs/user/mtu.rst
index 29e093539..1891994ec 100644
--- a/docs/user/mtu.rst
+++ b/docs/user/mtu.rst
@@ -19,7 +19,7 @@ Consider these key values:
- Encapsulation: Account for the overhead created by the configured mesh protocol
encapsulating the payload, which is up to 32 Byte (14 Byte Ethernet + 18 Byte
- batadv).
+ batman-adv).
- PMTU: What MTU does the path between your gateway and each of its peers support?
@@ -43,7 +43,7 @@ transporting IPv6.::
\ 1312 1294 1280 0
\---------+-----------------+-------------+----------------------------------+
- \TAP | batadv v15 | Ethernet | Payload |
+ \TAP | batman-adv v15 | Ethernet | Payload |
\-------+-----------------+-------------+----------------------------------+
\ ^
|
@@ -57,13 +57,13 @@ Calculating the maximum transport MTU is interesting, because it increases the
throughput, by allowing larger payloads to be transported, but also more difficult
as you have to take into account the tunneling overhead and each peers PMTU, which
varies between providers.
-The underlying reasons are mostly PPPoE, Tunneling and IPv6 transition technologies
+The underlying reasons are mostly PPPoE, tunneling and IPv6 transition technologies
like DS-Lite.
Example: The peer with the smallest MTU on your network is behind DS-Lite and can
transport IPv4 packets up to 1436 Bytes in size. Your tunnel uses IPv4 (20 Byte),
UDP (8 Byte), Fastd (24 byte) and you require TAP (14 Byte) for Layer 2 (Ethernet)
-Tunneling.::
+tunneling.::
1436 1416 1408 1384 1370 \
+-------------------+--------+-----------------------+-------------+------\
@@ -85,7 +85,7 @@ VPN Protocol Overhead (IPv4)
Overhead of the VPN protocol layers in bytes on top of an Ethernet frame.
+----------+-------+--------------+-----------+
-| | fastd | Tunneldigger | Wireguard |
+| | fastd | Tunneldigger | WireGuard |
+==========+=======+==============+===========+
| IPv4 | 20 | 20 | 20 |
+----------+-------+--------------+-----------+
@@ -105,7 +105,7 @@ Overhead of additional layers on top of the VPN packet needed for different VPN
providers.
+------------+-------+--------------+-----------+
-| | fastd | Tunneldigger | Wireguard |
+| | fastd | Tunneldigger | WireGuard |
+============+=======+==============+===========+
| IPv6 | / | / | 40 |
+------------+-------+--------------+-----------+
@@ -137,11 +137,11 @@ Suggestions:
for the WAN network.
+-------------------------------+-------+--------------+-----------+
-| | fastd | Tunneldigger | Wireguard |
+| | fastd | Tunneldigger | WireGuard |
+===============================+=======+==============+===========+
| max unfragmented payload\* | 1280 | 1280 | 1280 |
+-------------------------------+-------+--------------+-----------+
-| intermed layer overhead | 32 | 32 | 102 |
+| intermediate layer overhead | 32 | 32 | 102 |
+-------------------------------+-------+--------------+-----------+
| VPN MTU\*\* | 1312 | 1312 | 1382 |
+-------------------------------+-------+--------------+-----------+
@@ -170,7 +170,7 @@ Suggestions:
fragment larger packets transparently to avoid packet loss.
+-------------------------------+-------+--------------+-----------+
-| | fastd | Tunneldigger | Wireguard |
+| | fastd | Tunneldigger | WireGuard |
+===============================+=======+==============+===========+
| min acceptable WAN MTU (IPv4) | 1436 | 1436 | 1436 |
+-------------------------------+-------+--------------+-----------+
@@ -178,7 +178,7 @@ Suggestions:
+-------------------------------+-------+--------------+-----------+
| VPN MTU\*\* | 1370 | 1386 | 1376 |
+-------------------------------+-------+--------------+-----------+
-| intermed layer overhead | 32 | 32 | 102 |
+| intermediate layer overhead | 32 | 32 | 102 |
+-------------------------------+-------+--------------+-----------+
| max unfragmented payload\* | 1338 | 1354 | 1274 |
+-------------------------------+-------+--------------+-----------+
diff --git a/docs/user/site.rst b/docs/user/site.rst
index 96bb5eacf..f21778ee7 100644
--- a/docs/user/site.rst
+++ b/docs/user/site.rst
@@ -160,7 +160,7 @@ wifi24 \: optional
ap = {
ssid = 'alpha-centauri.freifunk.net',
owe_ssid = 'owe.alpha-centauri.freifunk.net',
- owe_transition_mode = true,
+ owe_transition_mode = true,
},
mesh = {
id = 'ueH3uXjdp',
@@ -328,7 +328,7 @@ mesh_vpn
implementation.
**Note:** It may be interesting to include the package *gluon-iptables-clamp-mss-to-pmtu*
- in the build when using *gluon-mesh-babel* to work around ICMP blackholes on the internet.
+ in the build when using *gluon-mesh-babel* to work around ICMP black holes on the internet.
::
@@ -777,7 +777,7 @@ to supply additional package feeds from which packages are built. The git reposi
specified here are retrieved in addition to the default feeds when ``make update``
is called.
-This file's format is very similar to the toplevel ``modules`` file of the Gluon
+This file's format is very similar to the top-level ``modules`` file of the Gluon
tree, with the important different that the list of feeds must be assigned to
the variable ``GLUON_SITE_FEEDS``. Multiple feed names must be separated by spaces,
for example::
diff --git a/docs/user/supported_devices.rst b/docs/user/supported_devices.rst
index e5733e33d..d8f53b8e1 100644
--- a/docs/user/supported_devices.rst
+++ b/docs/user/supported_devices.rst
@@ -173,12 +173,12 @@ ath79-mikrotik
brcm2708-bcm2708
----------------
-* RaspberryPi 1
+* Raspberry Pi 1
brcm2708-bcm2709
----------------
-* RaspberryPi 2
+* Raspberry Pi 2
ipq40xx-generic
@@ -337,7 +337,7 @@ mpc85xx-p1020
- WS-AP3825i
-* OCEDO
+* Ocedo
- Panda
--
GitLab