Skip to content
Snippets Groups Projects
Unverified Commit c1629967 authored by Matthias Schiffer's avatar Matthias Schiffer Committed by GitHub
Browse files

Merge pull request #3029 from bobidle/typos

docs: fix typos, change letter case and remove whitespace characters
parents f53efd9e c5520a52
No related branches found
No related tags found
No related merge requests found
Showing with 44 additions and 44 deletions
......@@ -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)
......
......@@ -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.
......
......@@ -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``:
......
......@@ -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
......
......@@ -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>`_.
......
......@@ -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.
......@@ -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
......
......@@ -18,7 +18,7 @@ ar71xx-generic
- Fritz!WLAN Repeater 450E
* OCEDO
* Ocedo
- Koala
......
......@@ -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.
......
......@@ -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
~~~~~~~~~~~~~
......
......@@ -81,7 +81,7 @@ ipq40xx-generic
- AVM
- FRITZBox 7520
- FRITZ!Box 7520
ipq40xx-mikrotik
......
......@@ -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
......
......@@ -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 |
+-------------------------------+-------+--------------+-----------+
......
......@@ -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::
......
......@@ -337,7 +337,7 @@ mpc85xx-p1020
- WS-AP3825i
* OCEDO
* Ocedo
- Panda
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment