Commit 0986ec7e authored by bobcanthelpyou's avatar bobcanthelpyou Committed by Martin Weinelt
Browse files

docs: fix typos and common misspellings (#1668)


(cherry picked from commit 170c494f409df37459d9aa9d5af8bc675b7f9d4a)
parent eb46e5a9
......@@ -36,9 +36,9 @@ rerun
`make update` also applies the patches that can be found in the directories found in
`patches`; the resulting branch will be called `patched`, while the commit specified in `modules`
can be refered to by the branch `base`.
can be referred to by the branch `base`.
After new patches have been commited on top of the `patched` branch (or existing commits
After new patches have been committed on top of the `patched` branch (or existing commits
since the base commit have been edited or removed), the patch directories can be regenerated
using
......
......@@ -99,7 +99,7 @@ target supports *per-default rootfs*).
Configuration
'''''''''''''
The ``config`` command allows to add arbitary target-specific OpenWrt configuration
The ``config`` command allows to add arbitrary target-specific OpenWrt configuration
to be emitted to ``.config``.
Notes
......
......@@ -74,7 +74,7 @@ Feature flags provide a convenient way to define package selections without
making it necessary to list each package explicitly.
The main feature flag definition file is ``package/features``, but each package
feed can provide additional defintions in a file called ``features`` at the root
feed can provide additional definitions in a file called ``features`` at the root
of the feed repository.
Each flag *$flag* without any explicit definition will simply include the package
......
......@@ -2,7 +2,7 @@ Config Mode
===========
The `Config Mode` consists of several modules that provide a range of different
condiguration options:
configuration options:
gluon-config-mode-core
This modules provides the core functionality for the config mode.
......
......@@ -51,14 +51,14 @@ Classes and methods
- *Form:write* ()
Is called after the form has beed submitted (but only if the data is valid). It
Is called after the form has been submitted (but only if the data is valid). It
is called last (after all options' *write* methods) and is usually used
to commit changed UCI packages.
The default implementation of *write* doesn't do anything, but it can be
overridden.
- *Section* (usually instanciated through *Form:section*)
- *Section* (usually instantiated through *Form:section*)
- *Section:option* (*type*, *id*, *title*, *description*)
......
......@@ -24,7 +24,7 @@ Information to be announced is currently split into three categories:
interfaces. This data can be used to determine the network topology.
All categories will have a ``node_id`` key. It should be used to
relate data of different catagories.
relate data of different categories.
Accessing Node Information
--------------------------
......@@ -117,7 +117,7 @@ The supported requests are:
gluon-neighbour-info
~~~~~~~~~~~~~~~~~~~~
The programm `gluon-neighbour-info` can be used to retrieve
The program `gluon-neighbour-info` can be used to retrieve
information from other nodes.
::
......
......@@ -193,8 +193,8 @@ domain.conf only variables
- prefix4
- extra_prefixes6
- To prevent accidential bridging of different domains, all meshing
technologies should be seperated:
- To prevent accidental bridging of different domains, all meshing
technologies should be separated:
- domain_seed (wired mesh)
......
Private WLAN
============
It is possible to set up a private WLAN that bridges the WAN port and is seperated from the mesh network.
It is possible to set up a private WLAN that bridges the WAN port and is separated from the mesh network.
Please note that you should not enable ``mesh_on_wan`` simultaneously.
The private WLAN can be enabled through the config mode if the package ``gluon-web-private-wifi`` is installed.
......
......@@ -20,7 +20,7 @@ Wired mesh encapsulation
Since version 2018.1, Gluon supports encapsulating wired mesh traffic in
`VXLAN <https://en.wikipedia.org/wiki/Virtual_Extensible_LAN>`_, a new standard with
usecases similar to VLANs, but a much greater ID space of 24bit; in addition, VXLAN
use cases similar to VLANs, but a much greater ID space of 24bit; in addition, VXLAN
packets pass through VLAN-aware switches without any special configuration.
Encapsulating mesh traffic has two advantages:
......
Welcome to Gluon
================
Gluon is a modular framework for creating OpenWrt-based firmwares for wireless mesh nodes.
Several Freifunk communities in Germany use Gluon as the foundation of their Freifunk firmwares.
Gluon is a modular framework for creating OpenWrt-based firmware images for wireless mesh nodes.
Several Freifunk communities in Germany use Gluon as the foundation of their Freifunk firmware.
.. toctree::
......
......@@ -5,7 +5,7 @@ the node will be placed in. If the selection has changed the upgrade scripts in
``/lib/gluon/upgrade/`` are triggered to update the nodes configuration.
Hiding domains could be useful for default or testing domains, which should not
be accidentally selected by a node operater.
be accidentally selected by a node operator.
domains/\*.conf
---------------
......
......@@ -11,7 +11,7 @@ Selected router
---------------
The router selection mechanism is independent from the batman-adv gateway mode.
In contrast, the device originating the router advertisment could be any router
In contrast, the device originating the router advertisement could be any router
or client connected to the mesh, as radv-filterd captures all router
advertisements originating from it. All nodes announcing router advertisement
**with** a default lifetime greater than 0 are being considered as candidates.
......
......@@ -6,7 +6,7 @@ in time. This is needed for switching between incompatible transport
protocols (e.g. 802.11s and IBSS or VXLAN).
Nodes will switch when the defined *switch-time* has passed. In case the node was
powered off while this was supposed to happen, it might not be able to aquire the
powered off while this was supposed to happen, it might not be able to acquire the
correct time. In this case, the node will switch after it has not seen any gateway
for a given period of time.
......
......@@ -3,7 +3,7 @@ gluon-web-admin
This package allows the user to set options like the password for ssh access
within config mode. You can define in your ``site.conf`` whether it should be
possible to access the nodes via ssh with a password or not and what the mimimum
possible to access the nodes via ssh with a password or not and what the minimum
password length must be.
site.conf
......
......@@ -31,7 +31,7 @@ and slowly increase to 1 until ``PRIORITY`` days have passed. From then, the pro
be configured in ``site.conf``. If the autoupdater is unable to determine the correct time, it will fall back to
a behavior similar to the old implementation (i.e. hourly update attempts).
Seperation of announced data
Separation of announced data
----------------------------
The data announced by alfred has been split into two data types:
......@@ -73,7 +73,7 @@ which allows simple configuration of batman-adv on the WAN interface.
Site validators
---------------
The content of the ``site.conf`` is now validated when the images are built to make it less likely to accidentially
The content of the ``site.conf`` is now validated when the images are built to make it less likely to accidentally
build broken images.
gluon-firewall
......
......@@ -43,7 +43,7 @@ See the *Site changes* section for details.
Experimental support for batman-adv compat 15
---------------------------------------------
As batman-adv has broken compatiblity starting with batman-adv 2014.0
As batman-adv has broken compatibility starting with batman-adv 2014.0
(bumping the "compat level" to 15), Gluon users must decide which
batman-adv version to use. The package for the old batman-adv version
``gluon-mesh-batman-adv`` has been renamed to ``gluon-mesh-batman-adv-14``,
......
......@@ -24,7 +24,7 @@ Bugfixes
~~~~~~~~
* Fix download of OpenSSL during build because of broken OpenSSL download servers (again...)
* Fix another ABI incompatiblity with the upstream kernel modules which prevented loading some filesystem-related modules
* Fix another ABI incompatibility with the upstream kernel modules which prevented loading some filesystem-related modules
* Fix potential MAC address conflicts on x86 target when using mesh-on-wan/lan
* Fix signal strength indicators on TP-LINK CPE210/510
* Fix the model name string on some NETGEAR WNDR3700v2
......
......@@ -82,7 +82,7 @@ All config and expert mode modules contain both English and German texts now. Th
locale should always be enabled in ``site.mk`` (as English is the fallback language),
German can be enabled in addition using the ``GLUON_LANGS`` setting.
The language shown is autmatically determined from the headers sent by the user's
The language shown is automatically determined from the headers sent by the user's
browser.
Mesh-on-LAN
......@@ -106,7 +106,7 @@ the WLAN adapters' transmission power can be changed in this package.
fastd "performance mode"
^^^^^^^^^^^^^^^^^^^^^^^^
The new package `gluon-luci-mesh-vpn-fastd` allows the user to switch between the `security` and
`performance` VPN settions. In `performance mode`, the method `null` will be prepended to the
`performance` VPN sections. In `performance mode`, the method `null` will be prepended to the
method list.
The new option ``configurable`` in the ``fastd_mesh_vpn`` section of ``site.conf`` must be set to `true`
......@@ -131,7 +131,7 @@ ffmap backend has been adjusted accordingly.
Nested peer groups
^^^^^^^^^^^^^^^^^^
Nested peer groups for the `fastd-mesh-vpn-fastd` package can now be configured in ``site.conf``,
each with its own peer limit. This allows to add additional constaints, for example to connect
each with its own peer limit. This allows to add additional constraints, for example to connect
to 2 peers altogether, but only 1 peer in each data center.
Autoupdater manual branch override
......
......@@ -19,8 +19,8 @@ Build
Don't overwrite the opkg repository key on each build.
AirOS 5.6.x compatiblity
^^^^^^^^^^^^^^^^^^^^^^^^
AirOS 5.6.x compatibility
^^^^^^^^^^^^^^^^^^^^^^^^^
Downgrading to AirOS 5.5.x before flashing Gluon on Airmax M XM/XW devices
(NanoStation, Bullet, ...) is not necessary anymore.
......@@ -28,9 +28,9 @@ Downgrading to AirOS 5.5.x before flashing Gluon on Airmax M XM/XW devices
Status page
^^^^^^^^^^^
* Fix purging of disappered neighbours from the list
* Fix purging of disappeared neighbours from the list
* Don't clear the signal graphs when scrolling in mobile browsers
* Improve browser compability (don't assume the Internationalization API is available,
* Improve browser compatibility (don't assume the Internationalization API is available,
fixes the display of numbers in Firefox for Android)
Config mode
......@@ -53,7 +53,7 @@ Known Issues
* The MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
This may lead to issues in environments where a fixed MAC address is expected (like VMware when promicious mode is disallowed).
This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).
* Inconsistent respondd/announced API (`#522 <https://github.com/freifunk-gluon/gluon/issues/522>`_)
......
......@@ -22,7 +22,7 @@ Known Issues
* The MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
This may lead to issues in environments where a fixed MAC address is expected (like VMware when promicious mode is disallowed).
This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).
* Inconsistent respondd API (`#522 <https://github.com/freifunk-gluon/gluon/issues/522>`_)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment