Skip to content

Commit a49f53a

Browse files
authored
Merge pull request #2834 from smoe/docs_typos
Docs typos
2 parents 6afa1ab + 4b2a82a commit a49f53a

3 files changed

Lines changed: 13 additions & 14 deletions

File tree

docs/src/drivers/hal_gpio.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
= Generic driver for any GPIO supported by gpiod.
77

8-
This driver has been tested on the Raspberry Pi, and should also work on Bananapi, Beaglebone, Pine64 (et al) and other single board computers, and potentially on other platforms.
8+
This driver has been tested on the Raspberry Pi, and should also work on Bananapi, Beaglebone, Pine64 (et al) and other single board computers, and potentially on other platforms.
99

1010
== Purpose
1111

@@ -20,7 +20,7 @@ loadrt hal_gpio inputs=GPIO5,GPIO6,GPIO12,GPIO13,GPIO16,GPIO17,GPIO18,GPIO19 \
2020
reset=GPIO21,GPIO22
2121
----
2222

23-
This driver relies on the libgpiod-dev library and the https://tracker.debian.org/pkg/libgpiod[gpiod] package, which contains a number of utilities for configuring and querying GPIO.
23+
This driver relies on the libgpiod-dev library and the https://tracker.debian.org/pkg/libgpiod[gpiod] package, which contains a number of utilities for configuring and querying GPIO.
2424
The GPIO pin names in the "loadrt" line of the HAL given above should be the names given by the "gpioinfo" command.
2525

2626
Sample output (truncated):
@@ -52,7 +52,9 @@ gpiochip0 - 54 lines:
5252
...
5353
----
5454

55-
A list of input and/or output pins should be specified as shown in the sample above. (The \ character is used for line continuation in HAL, and is used to improve readability. The pin names are case-sensitive and there must be no spaces in the strings, either beteen the comma-separated pins lists of the "=" signs.)
55+
A list of input and/or output pins should be specified as shown in the sample above.
56+
The \ character is used for line continuation in HAL, and is used to improve readability.
57+
The pin names are case-sensitive and there must be no spaces in the strings, neither between the comma-separated pins lists of the "=" signs.
5658

5759
Additional modifiers are:
5860
*invert* (valid for outputs only). Inverts the sense of the physical pin relative to the value in HAL.
@@ -112,8 +114,7 @@ If "access denied" messages are returned on loading the driver, try the followin
112114

113115
sudo groupadd gpio
114116

115-
2) Create a file called 90-gpio-access with the following contents (this
116-
is copied from the Raspbian install)
117+
2) Create a file called 90-gpio-access with the following contents (this is copied from the Raspbian install)
117118

118119
````
119120
SUBSYSTEM=="bcm2835-gpiomem", GROUP="gpio", MODE="0660"

docs/src/gui/qtvcp.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ add the handle patch file there, named like so <ORIGINAL SCREEN NAME>_handler.py
245245
ie for Qtdragon the file would be caller 'qtdragon_handler.py' +
246246

247247
Here is a sample to add X axis jog pins to a screen like Qtdragon: +
248-
248+
249249
[source,python]
250250
----
251251
import sys
@@ -364,7 +364,7 @@ def on_keycall_F11(self,event,state,shift,cntrl):
364364
# This function tells KEYBIND to call 'on_keycall_F10' when F10 is pressed.
365365
hdlr.KEYBIND.add_call('Key_F10','on_keycall_F10')
366366
367-
# Here we are instance patching the original handler file to add a new function
367+
# Here we are instance patching the original handler file to add a new function
368368
# that calls our new function (of the same name) defined in this file.
369369
self.on_keycall_F10 = types.MethodType(on_keycall_F10, self)
370370
@@ -601,7 +601,7 @@ Pick _'Main Window'_ and press the _'Create'_ button. +
601601
A _`MainWindow` widget_ is displayed.
602602

603603
We are going to make this window a specific non resizeable size:
604-
604+
605605
.Set `MainWindow` Minimum and Maximum Size
606606
* Grab the corner of the window and resize to an appropriate size, say 1000x600. +
607607
* Right click on the window and click set _minimum size_.
@@ -851,7 +851,7 @@ class HandlerClass:
851851
#####################
852852
853853
# keyboard jogging from key binding calls
854-
# double the rate if fast is true
854+
# double the rate if fast is true
855855
def kb_jog(self, state, joint, direction, fast = False, linear = True):
856856
if not STATUS.is_man_mode() or not STATUS.machine_is_on():
857857
return
@@ -993,7 +993,7 @@ If QtVCP finds these it will call them, if not it will silently ignore them.
993993
*`after_override__(self):`*::
994994
This function is called after the optional override file is loaded but +
995995
before the optional HAL file is loaded or HAL component is set ready.
996-
996+
997997
*`processed_key_event__(self,receiver,event,is_pressed,key,code,shift,cntrl):`*::
998998
This function is called to facilitate _keyboard jogging_, etc. +
999999
By using the _`keybinding` library_ this can be used to easily add functions bound to keypresses.

docs/src/man/man3/hm2_pktuart.3.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ A reasonable starting value for txmode is **0x00000A20**
9393
Bit 18 Odd Parity WO (1=odd, 0=even)
9494
Bits 15..8 InterFrame delay in bit times RW
9595
Bit 6 RXMask RO
96-
Bit 3 RXEnable (must be set to receive packets) RW
96+
Bit 3 RXEnable (must be set to receive packets) RW
9797
Bit 2 RXMask Enable (enables input data masking when transmitting) RW
9898
----
9999
For low baud rates **0x3FC0140C** will generally work, but the filter bits should really be set according to the actual baud rate.
@@ -194,15 +194,13 @@ int process(void *arg, long period) {
194194
195195
switch (state) {
196196
case START:
197-
198197
// Check for received data
199198
if (rxstatus & 0x200000) {
200199
state = WAIT_FOR_DATA_FRAME;
201200
break;
202201
}
203202
204203
// No incoming data, so service the outputs
205-
206204
if (time to send data){
207205
hm2_pktuart_send(pktUART_name, some_data);
208206
state = WAIT_FOR_SEND_COMPLETE;
@@ -223,7 +221,7 @@ int process(void *arg, long period) {
223221
state = WAIT_FOR_FRAME_SIZES;
224222
frame_inde = 0;
225223
break;
226-
224+
227225
case WAIT_FOR_FRAME_SIZES:
228226
case FETCH_MORE_DATA:
229227
// This step may need to be iterated if there are multiple frames

0 commit comments

Comments
 (0)