Skip to content
Snippets Groups Projects
Commit c5520a52 authored by Bob Idle's avatar Bob Idle
Browse files

docs: fix typos, change letter case and remove whitespace characters

parent f53efd9e
No related branches found
No related tags found
No related merge requests found
Showing with 44 additions and 44 deletions
...@@ -8,7 +8,7 @@ Gluon's source is kept in `git repositories`_ at GitHub. ...@@ -8,7 +8,7 @@ Gluon's source is kept in `git repositories`_ at GitHub.
Bug Tracker Bug Tracker
----------- -----------
The `main repo`_ does have issues enabled. The `main repo`_ does have issues enabled.
.. _main repo: https://github.com/freifunk-gluon/gluon .. _main repo: https://github.com/freifunk-gluon/gluon
...@@ -17,7 +17,7 @@ IRC ...@@ -17,7 +17,7 @@ IRC
Gluon's developers frequent the IRC chatroom `#gluon`_ on `hackint`_. Gluon's developers frequent the IRC chatroom `#gluon`_ on `hackint`_.
There is a `webchat`_ that allows for easy access from within your 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 .. _#gluon: ircs://irc.hackint.org/#gluon
.. _hackint: https://hackint.org/ .. _hackint: https://hackint.org/
...@@ -75,7 +75,7 @@ the code in the project is formatted in the same way. The following basic rules ...@@ -75,7 +75,7 @@ the code in the project is formatted in the same way. The following basic rules
apply: apply:
- use tabs instead of spaces - use tabs instead of spaces
- trailing whitespaces must be eliminated - trailing whitespace characters must be eliminated
- files need to end with a final newline - files need to end with a final newline
- newlines need to have Unix line endings (lf) - newlines need to have Unix line endings (lf)
......
...@@ -118,7 +118,7 @@ image output directory. ...@@ -118,7 +118,7 @@ image output directory.
aliases = {'aruba-instant-on-ap11'}, 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 images to be found under the different name on targets that perform model name
detection at runtime. detection at runtime.
......
...@@ -60,7 +60,7 @@ Features of ``push_pkg.sh``: ...@@ -60,7 +60,7 @@ Features of ``push_pkg.sh``:
* Works with native OpenWrt and Gluon packages. * Works with native OpenWrt and Gluon packages.
* Pushes to remote machines or local qemu instances. * 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. * Performs site.conf checks.
Implementation details of ``push_pkg.sh``: Implementation details of ``push_pkg.sh``:
......
...@@ -26,7 +26,7 @@ Let's start with an example: ...@@ -26,7 +26,7 @@ Let's start with an example:
return f 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 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 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. ...@@ -86,7 +86,7 @@ don't use offloading as long as both use the ``null@l2tp`` method.
Offloading on Gateways / Supernodes 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 fastd documentation section pertaining to the `offload configuration option
<https://fastd.readthedocs.io/en/stable/manual/config.html#option-offload>`_. <https://fastd.readthedocs.io/en/stable/manual/config.html#option-offload>`_.
......
...@@ -13,7 +13,7 @@ config_mode.remote_login.show_password_form \: optional ...@@ -13,7 +13,7 @@ config_mode.remote_login.show_password_form \: optional
- ``true`` the password section in config mode is shown - ``true`` the password section in config mode is shown
- ``false`` the password section in config mode is hidden - ``false`` the password section in config mode is hidden
- defaults to ``false`` - defaults to ``false``
config_mode.remote_login.min_password_length \: optional config_mode.remote_login.min_password_length \: optional
- sets the minimum allowed password length. Set this to ``1`` to disable the - sets the minimum allowed password length. Set this to ``1`` to disable the
length check. length check.
......
...@@ -146,7 +146,7 @@ Ignored tx-power offset on Ubiquiti AirMax devices ...@@ -146,7 +146,7 @@ Ignored tx-power offset on Ubiquiti AirMax devices
https://github.com/freifunk-gluon/gluon/issues/94 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 power offsets on Ubiquiti AirMax devices (Bullet M2, Picostation
M2, Nanostation (loco) M2, ...). Use Gluon with caution on these M2, Nanostation (loco) M2, ...). Use Gluon with caution on these
devices! Manual adjustment may be required. devices! Manual adjustment may be required.
...@@ -46,12 +46,12 @@ ar71xx-generic ...@@ -46,12 +46,12 @@ ar71xx-generic
brcm2708-bcm2708 brcm2708-bcm2708
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
* RaspberryPi 1 * Raspberry Pi 1
brcm2708-bcm2709 brcm2708-bcm2709
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
* RaspberryPi 2 * Raspberry Pi 2
New features New features
~~~~~~~~~~~~ ~~~~~~~~~~~~
......
...@@ -12,7 +12,7 @@ Bugfixes ...@@ -12,7 +12,7 @@ Bugfixes
* Fixes device alias for Ubiquiti UniFi AC LR. (`#1834 <https://github.com/freifunk-gluon/gluon/issues/1834>`_) * 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. 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 * 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 ...@@ -20,7 +20,7 @@ Other changes
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
* Linux kernel has been updated to either * Linux kernel has been updated to either
- 4.9.207 (ar71xx, brcm2708, mpc85xx) or - 4.9.207 (ar71xx, brcm2708, mpc85xx) or
- 4.14.160 (ipq40xx, ipq806x, mvebu, ramips, sunxi, x86). - 4.14.160 (ipq40xx, ipq806x, mvebu, ramips, sunxi, x86).
......
...@@ -18,7 +18,7 @@ ar71xx-generic ...@@ -18,7 +18,7 @@ ar71xx-generic
- Fritz!WLAN Repeater 450E - Fritz!WLAN Repeater 450E
* OCEDO * Ocedo
- Koala - Koala
......
...@@ -7,7 +7,7 @@ Bugfixes ...@@ -7,7 +7,7 @@ Bugfixes
* Fixes device alias for Ubiquiti UniFi AC LR. (`#1834 <https://github.com/freifunk-gluon/gluon/issues/1834>`_) * 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. 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. * 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 ...@@ -18,7 +18,7 @@ ath79-generic
- devolo WiFi pro 1750i - devolo WiFi pro 1750i
- devolo WiFi pro 1750x - devolo WiFi pro 1750x
- GL.iNet GL-AR300M-Lite - GL.iNet GL-AR300M-Lite
- OCEDO Raccoon - Ocedo Raccoon
- TP-Link Archer C6 v2 - TP-Link Archer C6 v2
ipq40xx-generic ipq40xx-generic
...@@ -53,7 +53,7 @@ mpc85xx-p1020 ...@@ -53,7 +53,7 @@ mpc85xx-p1020
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
- Enterasys WS-AP3710i - Enterasys WS-AP3710i
- OCEDO Panda - Ocedo Panda
ramips-mt7620 ramips-mt7620
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
......
...@@ -26,7 +26,7 @@ ath79-nand ...@@ -26,7 +26,7 @@ ath79-nand
- NETGEAR - NETGEAR
- WNDR4300 (v1) - WNDR4300 (v1)
lantiq-xrx200 lantiq-xrx200
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
...@@ -50,7 +50,7 @@ ramips-mt7621 ...@@ -50,7 +50,7 @@ ramips-mt7621
- GL.iNet - GL.iNet
- GL-MT1300 - GL-MT1300
- Mercusys - Mercusys
- MR70X (v1) - MR70X (v1)
...@@ -58,15 +58,15 @@ ramips-mt7621 ...@@ -58,15 +58,15 @@ ramips-mt7621
- Xiaomi - Xiaomi
- Mi Router 3G - Mi Router 3G
ramips-mt76x8 ramips-mt76x8
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
- TP-Link - TP-Link
- RE200 (v3) - RE200 (v3)
realtek-rtl838x realtek-rtl838x
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
...@@ -74,16 +74,16 @@ realtek-rtl838x ...@@ -74,16 +74,16 @@ realtek-rtl838x
- D-Link - D-Link
- DGS-1210-10P - DGS-1210-10P
ipq40xx-generic ipq40xx-generic
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
- AVM - AVM
- FRITZBox 7520 - FRITZ!Box 7520
ipq40xx-mikrotik ipq40xx-mikrotik
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
......
...@@ -6,7 +6,7 @@ Frequently Asked Questions ...@@ -6,7 +6,7 @@ Frequently Asked Questions
What hardware is supported? What hardware is supported?
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
A table with hardware supported by Gluon can be found on the `OpenWrt Wiki`_. 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. have a look at :doc:`../dev/hardware` for detailed hardware requirements.
.. _OpenWrt Wiki: https://openwrt.org/toh/views/toh_gluon_supported .. _OpenWrt Wiki: https://openwrt.org/toh/views/toh_gluon_supported
......
...@@ -246,7 +246,7 @@ Special variables ...@@ -246,7 +246,7 @@ Special variables
GLUON_AUTOREMOVE GLUON_AUTOREMOVE
Setting ``GLUON_AUTOREMOVE=1`` enables the ``CONFIG_AUTOREMOVE`` OpenWrt setting, which will delete package build 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 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. as it significantly increases incremental build times.
GLUON_DEBUG GLUON_DEBUG
......
...@@ -19,7 +19,7 @@ Consider these key values: ...@@ -19,7 +19,7 @@ Consider these key values:
- Encapsulation: Account for the overhead created by the configured mesh protocol - 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 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? - PMTU: What MTU does the path between your gateway and each of its peers support?
...@@ -43,7 +43,7 @@ transporting IPv6.:: ...@@ -43,7 +43,7 @@ transporting IPv6.::
\ 1312 1294 1280 0 \ 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 ...@@ -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 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 as you have to take into account the tunneling overhead and each peers PMTU, which
varies between providers. 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. like DS-Lite.
Example: The peer with the smallest MTU on your network is behind DS-Lite and can 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), 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) UDP (8 Byte), Fastd (24 byte) and you require TAP (14 Byte) for Layer 2 (Ethernet)
Tunneling.:: tunneling.::
1436 1416 1408 1384 1370 \ 1436 1416 1408 1384 1370 \
+-------------------+--------+-----------------------+-------------+------\ +-------------------+--------+-----------------------+-------------+------\
...@@ -85,7 +85,7 @@ VPN Protocol Overhead (IPv4) ...@@ -85,7 +85,7 @@ VPN Protocol Overhead (IPv4)
Overhead of the VPN protocol layers in bytes on top of an Ethernet frame. Overhead of the VPN protocol layers in bytes on top of an Ethernet frame.
+----------+-------+--------------+-----------+ +----------+-------+--------------+-----------+
| | fastd | Tunneldigger | Wireguard | | | fastd | Tunneldigger | WireGuard |
+==========+=======+==============+===========+ +==========+=======+==============+===========+
| IPv4 | 20 | 20 | 20 | | IPv4 | 20 | 20 | 20 |
+----------+-------+--------------+-----------+ +----------+-------+--------------+-----------+
...@@ -105,7 +105,7 @@ Overhead of additional layers on top of the VPN packet needed for different VPN ...@@ -105,7 +105,7 @@ Overhead of additional layers on top of the VPN packet needed for different VPN
providers. providers.
+------------+-------+--------------+-----------+ +------------+-------+--------------+-----------+
| | fastd | Tunneldigger | Wireguard | | | fastd | Tunneldigger | WireGuard |
+============+=======+==============+===========+ +============+=======+==============+===========+
| IPv6 | / | / | 40 | | IPv6 | / | / | 40 |
+------------+-------+--------------+-----------+ +------------+-------+--------------+-----------+
...@@ -137,11 +137,11 @@ Suggestions: ...@@ -137,11 +137,11 @@ Suggestions:
for the WAN network. for the WAN network.
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| | fastd | Tunneldigger | Wireguard | | | fastd | Tunneldigger | WireGuard |
+===============================+=======+==============+===========+ +===============================+=======+==============+===========+
| max unfragmented payload\* | 1280 | 1280 | 1280 | | max unfragmented payload\* | 1280 | 1280 | 1280 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| intermed layer overhead | 32 | 32 | 102 | | intermediate layer overhead | 32 | 32 | 102 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| VPN MTU\*\* | 1312 | 1312 | 1382 | | VPN MTU\*\* | 1312 | 1312 | 1382 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
...@@ -170,7 +170,7 @@ Suggestions: ...@@ -170,7 +170,7 @@ Suggestions:
fragment larger packets transparently to avoid packet loss. fragment larger packets transparently to avoid packet loss.
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| | fastd | Tunneldigger | Wireguard | | | fastd | Tunneldigger | WireGuard |
+===============================+=======+==============+===========+ +===============================+=======+==============+===========+
| min acceptable WAN MTU (IPv4) | 1436 | 1436 | 1436 | | min acceptable WAN MTU (IPv4) | 1436 | 1436 | 1436 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
...@@ -178,7 +178,7 @@ Suggestions: ...@@ -178,7 +178,7 @@ Suggestions:
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| VPN MTU\*\* | 1370 | 1386 | 1376 | | VPN MTU\*\* | 1370 | 1386 | 1376 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| intermed layer overhead | 32 | 32 | 102 | | intermediate layer overhead | 32 | 32 | 102 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
| max unfragmented payload\* | 1338 | 1354 | 1274 | | max unfragmented payload\* | 1338 | 1354 | 1274 |
+-------------------------------+-------+--------------+-----------+ +-------------------------------+-------+--------------+-----------+
......
...@@ -160,7 +160,7 @@ wifi24 \: optional ...@@ -160,7 +160,7 @@ wifi24 \: optional
ap = { ap = {
ssid = 'alpha-centauri.freifunk.net', ssid = 'alpha-centauri.freifunk.net',
owe_ssid = 'owe.alpha-centauri.freifunk.net', owe_ssid = 'owe.alpha-centauri.freifunk.net',
owe_transition_mode = true, owe_transition_mode = true,
}, },
mesh = { mesh = {
id = 'ueH3uXjdp', id = 'ueH3uXjdp',
...@@ -328,7 +328,7 @@ mesh_vpn ...@@ -328,7 +328,7 @@ mesh_vpn
implementation. implementation.
**Note:** It may be interesting to include the package *gluon-iptables-clamp-mss-to-pmtu* **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 ...@@ -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`` specified here are retrieved in addition to the default feeds when ``make update``
is called. 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 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, the variable ``GLUON_SITE_FEEDS``. Multiple feed names must be separated by spaces,
for example:: for example::
......
...@@ -173,12 +173,12 @@ ath79-mikrotik ...@@ -173,12 +173,12 @@ ath79-mikrotik
brcm2708-bcm2708 brcm2708-bcm2708
---------------- ----------------
* RaspberryPi 1 * Raspberry Pi 1
brcm2708-bcm2709 brcm2708-bcm2709
---------------- ----------------
* RaspberryPi 2 * Raspberry Pi 2
ipq40xx-generic ipq40xx-generic
...@@ -337,7 +337,7 @@ mpc85xx-p1020 ...@@ -337,7 +337,7 @@ mpc85xx-p1020
- WS-AP3825i - WS-AP3825i
* OCEDO * Ocedo
- Panda - Panda
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment