8000 Fix a few typos (#697) · macmpi/documentation@8f06c6f · GitHub
[go: up one dir, main page]

Skip to content

Commit 8f06c6f

Browse files
HairyFotrJamesH65
authored andcommitted
Fix a few typos (raspberrypi#697)
* Fix a few typos * One additional typo * copy edits
1 parent d2f4f58 commit 8f06c6f

File tree

17 files changed

+24
-24
lines changed

17 files changed

+24
-24
lines changed

configuration/cmdline-txt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ There are many kernel command line parameters, some of which are defined by the
1515
- console: defines the serial console. There are usually two entries:
1616
- `console=serial0,115200`
1717
- `console=tty1`
18-
- root: defines the location of the root filesystem, e.g. `root=/dev/mmcblk0p2` means multmedia card block 0 partition 2.
18+
- root: defines the location of the root filesystem, e.g. `root=/dev/mmcblk0p2` means multimedia card block 0 partition 2.
1919
- rootfstype: defines what type of filesystem the rootfs uses, e.g. `rootfstype=ext4`
2020
- elevator: specifies the I/O scheduler to use. `elevator=deadline` means the kernel imposes a deadline on all I/O operations to prevent request starvation.
21-
- quiet: sets the default kernel log level to `KERN_WARNING`, which supresses all but very serious log messages during boot.
21+
- quiet: sets the default kernel log level to `KERN_WARNING`, which suppresses all but very serious log messages during boot.
2222

2323

2424
#### Other Entries (not exhaustive)

configuration/config-txt/boot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Set the `disable_commandline_tags` command to `1` to stop `start.elf` from filli
3131

3232
### kernel
3333

34-
`kernel` is the alternative filename on the boot partition to use when loading the kernel. The default value on the Pi 1, Pi Zero, and Compute Module is is `kernel.img`, and on the Pi 2, Pi 3, and Compute Module 3 it is `kernel7.img`. If `kernel8.img` is present on the Pi 3 or Compute Module 3, it will be loaded in preference and entered in 64-bit mode.
34+
`kernel` is the alternative filename on the boot partition to use when loading the kernel. The default value on the Pi 1, Pi Zero, and Compute Module is `kernel.img`, and on the Pi 2, Pi 3, and Compute Module 3 it is `kernel7.img`. If `kernel8.img` is present on the Pi 3 or Compute Module 3, it will be loaded in preference and entered in 64-bit mode.
3535

3636
### kernel_address
3737

configuration/config-txt/overclocking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ By default (`force_turbo=0`) the "On Demand" CPU frequency driver will raise clo
5151

5252
#### never_over_voltage
5353

54-
Sets a bit in the OTP memory (one time programmable) that prevents the device from being overvoltaged. This is intended to lock the device down so the the warranty bit cannot be set either inadvertently or maliciously by using an invalid overvoltage.
54+
Sets a bit in the OTP memory (one time programmable) that prevents the device from being overvoltaged. This is intended to lock the device down so the warranty bit cannot be set either inadvertently or maliciously by using an invalid overvoltage.
5555

5656
#### disable_auto_turbo
5757

configuration/config-txt/video.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Setting `hdmi_ignore_cec` to `1` pretends that [CEC](https://en.wikipedia.org/wi
8080

8181
#### cec_osd_name
8282

83-
The `cec_osd_name` command sets the intial CEC name of the device. The default is Raspberry Pi.
83+
The `cec_osd_name` command sets the initial CEC name of the device. The default is Raspberry Pi.
8484

8585
#### hdmi_pixel_encoding
8686

configuration/device-tree.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ string-list = "red fish", "blue fish";
123123

124124
The `/include/` directive results in simple textual inclusion, much like C's `#include` directive, but a feature of the Device Tree compiler leads to different usage patterns. Given that nodes are named, potentially with absolute paths, it is possible for the same node to appear twice in a DTS file (and its inclusions). When this happens, the nodes and properties are combined, interleaving and overwriting properties as required (later values override earlier ones).
125125

126-
In the example above, the second appearanace of `/node2` causes a new property to be added to the original:
126+
In the example above, the second appearance of `/node2` causes a new property to be added to the original:
127127

128128
```
129129
/node2 {
@@ -686,7 +686,7 @@ dtc -I fs -O dtb -o base.dtb /proc/device-tree
686686
```
687687
This will include any overlays and parameters you have applied so far, either in `config.txt` or by loading them at runtime, which may or may not be what you want. Alternatively...
688688

689-
b) copy it from the source DTBs in /boot. This won't include overlays and parameters, but it also won't include any other modifications by the firmware. To allow testing of all overlays, the `dtmerge` utility will create some of the the board-specific aliases ("i2c_arm", etc.), but this means that the result of a merge will include more differences from the original DTB than you might expect. The solution to this is to use dtmerge to make the copy:
689+
b) copy it from the source DTBs in /boot. This won't include overlays and parameters, but it also won't include any other modifications by the firmware. To allow testing of all overlays, the `dtmerge` utility will create some of the board-specific aliases ("i2c_arm", etc.), but this means that the result of a merge will include more differences from the original DTB than you might expect. The solution to this is to use dtmerge to make the copy:
690690

691691
```
692692
dtmerge /boot/bcm2710-rpi-3-b.dtb base.dtb -

configuration/security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ You can specify the service even if you do not know which port it uses. This exa
208208
sudo ufw allow ssh
209209
```
210210

211-
The status commmand lists all current settings for the firewall:
211+
The status command lists all current settings for the firewall:
212212

213213
```
214214
sudo ufw status
@@ -222,7 +222,7 @@ Limit login attempts on ssh port using tcp: this denies connection if an IP addr
222222
sudo ufw limit ssh/tcp
223223
```
224224

225-
Deny access to port 30 from IP adress 192.168.2.1
225+
Deny access to port 30 from IP address 192.168.2.1
226226

227227
```
228228
sudo ufw deny from 192.168.2.1 port 30

configuration/uart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ The SoCs used on the Raspberry Pis have two built-in UARTs, a [PL011](http://inf
44

55
By default, on Raspberry Pis equipped with the wireless/Bluetooth module (Raspberry Pi 3 and Raspberry Pi Zero W), the PL011 UART is connected to the BT module, while the mini UART is used for Linux console output. On all other models the PL011 is used for the Linux console output.
66

7-
In Linux device terms, by default, /dev/ttyS0 refers to to the mini UART, and /dev/ttyAMA0 refers to the PL011. The primary UART is that assigned to the Linux console, which depends on the Raspberry Pi model as described above, and can be accessed via /dev/serial0.
7+
In Linux device terms, by default, /dev/ttyS0 refers to the mini UART, and /dev/ttyAMA0 refers to the PL011. The primary UART is that assigned to the Linux console, which depends on the Raspberry Pi model as described above, and can be accessed via /dev/serial0.
88

99
## Mini UART and CPU core frequency
1010

11-
The baud rate of the mini UART is linked to the core frequency of the VPU on the VC4 GPU. This means that as the VPU frequency governor varies the core frequency, the baud rate of the UART also changes. This makes the UART of limited use in the default state. Also, when the linux console uses the mini UART (Raspberry Pi 3, Raspberry Pi Zero W), as a consequence of the UART being disabled, the console is also disabled.
11+
The baud rate of the mini UART is linked to the core frequency of the VPU on the VC4 GPU. This means that as the VPU frequency governor varies the core frequency, the baud rate of the UART also changes. This makes the UART of limited use in the default state. Also, when the Linux console uses the mini UART (Raspberry Pi 3, Raspberry Pi Zero W), as a consequence of the UART being disabled, the console is also disabled.
1212

1313
The Linux console can be re-enabled by adding `enable_uart=1` to config.txt. This also fixes the core_freq to 250Mhz (unless force_turbo is set, when it will fixed to 400Mhz), which means that the UART baud rate stays consistent.
1414

configuration/wireless/access-point.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ By this point, the Raspberry Pi is acting as an access point, and other devices
138138
<a name="internet-sharing"></a>
139139
## Using the Raspberry Pi as an access point to share an internet connection
140140

141-
One common use of the Raspberry Pi as an access point is to provide wireless conections to a wired Ethernet connection, so that anyone logged into the access point can access the internet, providing of course that the wired Ethernet on the Pi can connect to the internet via some sort of router.
141+
One common use of the Raspberry Pi as an access point is to provide wireless connections to a wired Ethernet connection, so that anyone logged into the access point can access the internet, providing of course that the wired Ethernet on the Pi can connect to the internet via some sort of router.
142142

143143
To do this, a 'bridge' needs to put in place between the wireless device and the Ethernet device on the access point Raspberry Pi. This bridge will pass all traffic between the two interfaces. Install the following packages to enable the access point setup and bridging.
144144

hardware/computemodule/cm-peri-sw-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Note that `dt-blob.bin` is in compiled device tree format, but is only read by t
8585
A guide to creating dt-blob.bin is [here](../../configuration/pin-configuration.md).
8686
A comprehensive guide to the Linux Device Tree for Raspberry Pi is [here](../../configuration/device-tree.md).
8787

88-
During boot, the user can specify a specific ARM device tree to use via the `device_tree` parameter in `config.txt`, for example adding the line `device_tree=mydt.dtb` to `config.txt` where `mydt.dtb` is the dtb file to load instead of one of the standard ARM dtb files. While a user can create a full device tree for his or her Compute Module product, the recommended way to add hardware is to use overlays (see next section).
88+
During boot, the user can specify a specific ARM device tree to use via the `device_tree` parameter in `config.txt`, for example adding the line `device_tree=mydt.dtb` to `config.txt` where `mydt.dtb` is the dtb file to load instead of one of the standard ARM dtb files. While a user can create a full device tree for their Compute Module product, the recommended way to add hardware is to use overlays (see next section).
8989

9090
In addition to loading an ARM dtb, `start.elf` supports loading additional Device Tree 'overlays' via the `dtoverlay` parameter in `config.txt`, for example adding as many `dtoverlay=myoverlay` lines as required as overlays to `config.txt`, noting that overlays live in `/overlays` and are suffixed `-overlay.dtb` e.g. `/overlays/myoverlay-overlay.dtb`. Overlays are merged with the base dtb file before the data is passed to the Linux kernel when it starts.
9191

hardware/display/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ NB: With the display connected to the GPIO I2C pins, the GPU will assume control
2626

2727
## Screen Orientation
2828

29-
LCD displays have an optimum viewing angle, and depending on how the screen is mounted it may be necessary to change the orientation of the display to give the best results. By default, the Raspbery Pi display and Raspberry Pi are set up to work best when viewed from slightly above, for example on a desktop. If viewing from below, you can physically rotate the display, and then tell the system software to compensate by running the screen upside down.
29+
LCD displays have an optimum viewing angle, and depending on how the screen is mounted it may be necessary to change the orientation of the display to give the best results. By default, the Raspberry Pi display and Raspberry Pi are set up to work best when viewed from slightly above, for example on a desktop. If viewing from below, you can physically rotate the display, and then tell the system software to compensate by running the screen upside down.
3030

3131
To flip the display, add, anywhere in the file `\boot\config.txt`, the following line:
3232

0 commit comments

Comments
 (0)
0