From 04f6d0a26109e57a817455686fb889b3b7bb3e27 Mon Sep 17 00:00:00 2001
From: bobcanthelpyou <bob@canthelpyou.com>
Date: Mon, 1 Apr 2019 03:02:35 +0200
Subject: [PATCH] docs: fix typos and small text improvements
(cherry picked from commit ff7aeafad2a5bcae1b965e86cfb128dd24a78daa)
---
docs/dev/hardware.rst | 6 +++---
docs/dev/site_library.rst | 2 +-
docs/dev/wan.rst | 2 +-
docs/dev/web/controller.rst | 2 +-
docs/features/autoupdater.rst | 4 ++--
docs/features/configmode.rst | 2 +-
docs/features/multidomain.rst | 2 +-
docs/features/private-wlan.rst | 2 +-
docs/user/getting_started.rst | 3 ---
docs/user/site.rst | 4 ++--
docs/user/x86.rst | 4 ++--
11 files changed, 15 insertions(+), 18 deletions(-)
diff --git a/docs/dev/hardware.rst b/docs/dev/hardware.rst
index bde57f329..4985fa444 100644
--- a/docs/dev/hardware.rst
+++ b/docs/dev/hardware.rst
@@ -31,14 +31,14 @@ can work::
lua -e 'print(require("platform_info").get_image_name())'
-While porting Gluon to a new device, it might happen that the profile name is un-
-known. Best practise is to generate an image first by using an arbitrary value
+While porting Gluon to a new device, it might happen that the profile name is
+unknown. Best practise is to generate an image first by using an arbitrary value
and then executing the lua command on the device and use its output from then on.
The second parameter defines the name of the image files generated by OpenWrt. Usually,
it is also the OpenWrt profile name; for devices that still use the old image build
code, a third parameter with the OpenWrt profile name can be passed. The profile names
-can be found in the image Makefiles in ``lede/target/linux/<target>/image/Makefile``.
+can be found in the image Makefiles in ``openwrt/target/linux/<target>/image/Makefile``.
Examples::
diff --git a/docs/dev/site_library.rst b/docs/dev/site_library.rst
index 991e3cb52..eaac97fb5 100644
--- a/docs/dev/site_library.rst
+++ b/docs/dev/site_library.rst
@@ -11,7 +11,7 @@ from Lua scripts. Example:
The *site* object in this example does not directly represent the *site.conf* data structure;
instead, it is wrapped in a way that makes it more convenient to access deeply nested elements.
-To access the the underlying values, they must be unwrapped using the function call notation
+To access the underlying values, they must be unwrapped using the function call notation
(the ``()`` after ``site.wifi24.ap.ssid`` in the example).
The wrapper objects have two advantages over simple Lua tables:
diff --git a/docs/dev/wan.rst b/docs/dev/wan.rst
index 9742bf2b7..86455e915 100644
--- a/docs/dev/wan.rst
+++ b/docs/dev/wan.rst
@@ -5,7 +5,7 @@ As the WAN port of a node will be connected to a user's private network, it
is essential that the node only uses the WAN when it is absolutely necessary.
There are two cases in which the WAN port is used:
-* Mesh VPN (package ``gluon-mesh-vpn-fastd``
+* Mesh VPN (package ``gluon-mesh-vpn-fastd``)
* DNS to resolve the VPN servers' addresses (package ``gluon-wan-dnsmasq``)
After the VPN connection has been established, the node should be able to reach
diff --git a/docs/dev/web/controller.rst b/docs/dev/web/controller.rst
index 9bea74eb3..3f63ef01a 100644
--- a/docs/dev/web/controller.rst
+++ b/docs/dev/web/controller.rst
@@ -71,7 +71,7 @@ Useful functions:
values for the given key.
- *status* (*code*, *message*): Writes the HTTP status to the reply. Has no effect
if a status has already been sent or non-header data has been written.
- - *header* (*key*, *value*): Adds an HTTP header to the reply to be sent to to
+ - *header* (*key*, *value*): Adds an HTTP header to the reply to be sent to
the client. Has no effect when non-header data has already been written.
- *prepare_content* (*mime*): Sets the *Content-Type* header to the given MIME
type, potentially setting additional headers or modifying the MIME type to
diff --git a/docs/features/autoupdater.rst b/docs/features/autoupdater.rst
index 840563a73..014ee59f5 100644
--- a/docs/features/autoupdater.rst
+++ b/docs/features/autoupdater.rst
@@ -39,8 +39,8 @@ A fully automated nightly build could use the following commands:
make update
make clean GLUON_TARGET=ar71xx-generic
NUM_CORES_PLUS_ONE=$(expr $(nproc) + 1)
- make -j$NUM_CORES_PLUS_ONE GLUON_TARGET=ar71xx-generic GLUON_BRANCH=experimental
- make manifest GLUON_BRANCH=$GLUON_BRANCH GLUON_RELEASE=$GLUON_RELEASE
+ make -j$NUM_CORES_PLUS_ONE GLUON_TARGET=ar71xx-generic GLUON_BRANCH=experimental GLUON_RELEASE=$GLUON_RELEASE
+ make manifest GLUON_BRANCH=experimental GLUON_RELEASE=$GLUON_RELEASE
contrib/sign.sh $SECRETKEY output/images/sysupgrade/experimental.manifest
rm -rf /where/to/put/this/experimental
diff --git a/docs/features/configmode.rst b/docs/features/configmode.rst
index a6e8d9bab..2a09ecd8e 100644
--- a/docs/features/configmode.rst
+++ b/docs/features/configmode.rst
@@ -15,7 +15,7 @@ Activating Config Mode
Config Mode is automatically entered at the first boot. You can re-enter
Config Mode by pressing and holding the RESET/WPS button for about three
-seconds. The device should reboot (all LEDs will turn of briefly) and
+seconds. The device should reboot (all LEDs will turn off briefly) and
Config Mode will be available.
diff --git a/docs/features/multidomain.rst b/docs/features/multidomain.rst
index 107c83d30..825b37a3a 100644
--- a/docs/features/multidomain.rst
+++ b/docs/features/multidomain.rst
@@ -161,7 +161,7 @@ site.conf only variables
- mesh_vpn.fastd.syslog_level
- wifi*.supported_rates
- - wifi*.basic_rates
+ - wifi*.basic_rate
- timezone
- regdom
diff --git a/docs/features/private-wlan.rst b/docs/features/private-wlan.rst
index c047f8ae1..57b18fdda 100644
--- a/docs/features/private-wlan.rst
+++ b/docs/features/private-wlan.rst
@@ -19,7 +19,7 @@ You may also enable a private WLAN using the command line::
uci set wireless.wan_radio$RID.ssid="$SSID"
uci set wireless.wan_radio$RID.key="$KEY"
uci set wireless.wan_radio$RID.disabled=0
- uci set wireless.wan_radio$RID.macaddr="$($(echo "lua -e print(require('gluon.util').generate_mac(3+4*$RID))"))"
+ uci set wireless.wan_radio$RID.macaddr=$(lua -e "print(require('gluon.util').generate_mac(3+4*$RID))")
uci commit
wifi
diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst
index 90d4d49a1..80568a424 100644
--- a/docs/user/getting_started.rst
+++ b/docs/user/getting_started.rst
@@ -186,9 +186,6 @@ GLUON_TARGET
Special variables
.................
-GLUON_BUILDDIR
- Working directory during build. Defaults to ``build``.
-
GLUON_IMAGEDIR
Path where images will be stored. Defaults to ``$(GLUON_OUTPUTDIR)/images``.
diff --git a/docs/user/site.rst b/docs/user/site.rst
index cd5aa7449..50fe03b97 100644
--- a/docs/user/site.rst
+++ b/docs/user/site.rst
@@ -69,7 +69,7 @@ timezone
-- Europe/Berlin
timezone = 'CET-1CEST,M3.5.0,M10.5.0/3'
-ntp_server
+ntp_servers
List of NTP servers available in your community or used by your community, e.g.:
::
@@ -661,7 +661,7 @@ Site modules
The file ``modules`` in the site repository is completely optional and can be used
to supply additional package feeds from which packages are built. The git repositories
specified here are retrieved in addition to the default feeds when ``make update``
-it called.
+is called.
This file's format is very similar to the toplevel ``modules`` file of the Gluon
tree, with the important different that the list of feeds must be assigned to
diff --git a/docs/user/x86.rst b/docs/user/x86.rst
index a65edfcc7..0aadee434 100644
--- a/docs/user/x86.rst
+++ b/docs/user/x86.rst
@@ -19,8 +19,8 @@ The following targets for x86 images exist:
* `virtualbox` (VDI image)
* `vmware` (VMDK image)
- These images only differ in the image file format, the content is the same. Therefore there is
- only a single `x86-generic` sysupgrade image instead of three.
+ These images differ in the image file format, the content is the same. Therefore
+ a single `x86-generic` sysupgrade image is provided, only.
`x86-geode`
x86 image for Geode CPUs.
--
GitLab