Skip to content

Commit debf37b

Browse files
committed
documentation: Fixed po4a warnings on itemizations
1 parent fa591de commit debf37b

4 files changed

Lines changed: 36 additions & 25 deletions

File tree

docs/src/gui/gmoccapy.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ If not set, half of 'MAX_LINEAR_VELOCITY' will be used.
170170
If that value is also not given, it will default to 180.
171171

172172
- _MAX_LINEAR_VELOCITY = 230.0_ - Sets the maximal velocity of the machine.
173-
This value will also be the maximum linear jog velocity.
173+
This value will also be the maximum linear jog velocity.
174174
+
175175
[NOTE]
176176
Defaults to 600 if not set.
@@ -685,18 +685,21 @@ In a future release it will be integrated in the settings page.
685685
- *gmoccapy.spc_jog_vel.scale* _(float IN)_ - A value to scale the output value (handy to change units/min to units/sec)
686686
- *gmoccapy.spc_jog_vel.value* _(float OUT)_ - Value of the widget
687687
- *gmoccapy.spc_jog_vel.scaled-value* _(float OUT)_ - Scaled value of the widget
688+
688689
.FEED
689690
- *gmoccapy.spc_feed.increase* _(bit IN)_ - As long as True the value of the slider will increase
690691
- *gmoccapy.spc_feed.decrease* _(bit IN)_ - As long as True the value of the slider will decrease
691692
- *gmoccapy.spc_feed.scale* _(float IN)_ - A value to scale the output value (handy to change units/min to units/sec)
692693
- *gmoccapy.spc_feed.value* _(float OUT)_ - Value of the widget
693694
- *gmoccapy.spc_feed.scaled-value* _(float OUT)_ - Scaled value of the widget
695+
694696
.SPINDLE
695697
- *gmoccapy.spc_spindle.increase* _(bit IN)_ - As long as True the value of the slider will increase
696698
- *gmoccapy.spc_spindle.decrease* _(bit IN)_ - As long as True the value of the slider will decrease
697699
- *gmoccapy.spc_spindle.scale* _(float IN)_ - A value to scale the output value (handy to change units/min to units/sec)
698700
- *gmoccapy.spc_spindle.value* _(float OUT)_ - Value of the widget
699701
- *gmoccapy.spc_spindle.scaled-value* _(float OUT)_ - Scaled value of the widget
702+
700703
.RAPIDS
701704
- *gmoccapy.spc_rapid.increase* _(bit IN)_ - As long as True the value of the slider will increase
702705
- *gmoccapy.spc_rapid.decrease* _(bit IN)_ - As long as True the value of the slider will decrease

docs/src/man/man1/halcompile.1.adoc

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -83,30 +83,29 @@ Extra arguments passed to the linker.
8383
*halcompile* performs many different functions:
8484

8585
* Compile *.comp* and *.c* files into *.so* or *.ko* HAL realtime
86-
components (the *--compile* flag)
87-
* Compile *.comp* and *.c* files into HAL non-realtime components (the
88-
*--compile --userspace* flag)
86+
components (the *--compile* flag)
87+
* Compile *.comp* and *.c* files into HAL non-realtime components
88+
(the *--compile --userspace* flag)
8989
* Preprocess *.comp* files into *.c* files (the *--preprocess* flag)
9090
* Extract documentation from *.comp* files into asciidoc or manpage
91-
section *1* or *9* files (the *--adoc* and *--document* flags)
92-
* Display documentation from *.comp* files onscreen (the *--view-doc*
93-
flag)
91+
section *1* or *9* files (the *--adoc* and *--document* flags)
92+
* Display documentation from *.comp* files onscreen (the *--view-doc* flag)
9493
* Compile and install *.comp* and *.c* files into the proper directory
95-
for HAL realtime components (the *--install* flag), which may require
96-
_sudo_ to write to system directories.
94+
for HAL realtime components (the *--install* flag),
95+
which may require _sudo_ to write to system directories.
9796
* Install *.c* and *.py* files into the proper directory for HAL
98-
non-realtime components (the *--install* *--userspace* flag), which may
99-
require _sudo_ to write to system directories.
97+
non-realtime components (the *--install* *--userspace* flag), which may
98+
require _sudo_ to write to system directories.
10099
* Extract documentation from *.comp* files into *.1* or *.9* manpage
101-
files in the proper system directory (the *--install* flag), which may
102-
require _sudo_ to write to system directories.
100+
files in the proper system directory (the *--install* flag), which may
101+
require _sudo_ to write to system directories.
103102
* Preprocess *.comp* files into *.c* files (the *--preprocess* flag)
104103

105104
== SEE ALSO
106105

107-
_Halcompile HAL Component Generator_ in the LinuxCNC documentation for a
108-
full description of the *.comp* syntax, along with examples
106+
* _Halcompile HAL Component Generator_ in the LinuxCNC documentation for a
107+
full description of the *.comp* syntax, along with examples
109108

110-
*pydoc, HAL* and _Creating Non-realtime Python Components_ in the
111-
LinuxCNC documentation for documentation on the Python interface to HAL
112-
components
109+
* *pydoc, HAL* and _Creating Non-realtime Python Components_ in the
110+
LinuxCNC documentation for documentation on the Python interface to HAL
111+
components

docs/src/man/man1/haltcl.1.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ be set up with a single command.
2323
If specified, the INI file is read and used to create Tcl global variable arrays.
2424
An array is created for each SECTION of the INI file with elements for each ITEM in the section.
2525
+
26-
For example, if the INI file contains:
26+
For example, if the INI file contains:
2727
+
2828
----
2929
[SECTION_A]
@@ -34,7 +34,7 @@ ITEM_2 = 2
3434
ITEM_1 = 10
3535
----
3636
+
37-
The corresponding Tcl variables are:
37+
The corresponding Tcl variables are:
3838
+
3939
----
4040
SECTION_A(ITEM_1) = 1

docs/src/man/man9/hm2_rpspi.9.adoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,20 @@ The SPI driver generates (very) discrete clock frequency values,
105105
especially in the MHz range because of a simple clock divider structure.
106106
The base frequency is 250 MHz and the divider for SPI0/SPI1 scales using
107107
discrete factors. The following list specifies the *spiclk_rate* setting
108-
and the discrete SPI clock frequency (250 MHz / (2n) for n > 1): - 62500
109-
- 62.500 MHz, - 41667 - 41.667 MHz, - 31250 - 31.250 MHz, - 25000 -
110-
25.000 MHz, - 20834 - 20.833 MHz, - 17858 - 17.857 MHz, - 15625 - 15.625
111-
MHz, - 13889 - 13.889 MHz, - 12500 - 12.500 MHz, - 11364 - 11.364 MHz, -
112-
10417 - 10.417 MHz, - 9616 - 9.615 MHz, - ....
108+
and the discrete SPI clock frequency (250 MHz / (2n) for n > 1):
109+
- 62500 - 62.500 MHz,
110+
- 41667 - 41.667 MHz,
111+
- 31250 - 31.250 MHz,
112+
- 25000 - 25.000 MHz,
113+
- 20834 - 20.833 MHz,
114+
- 17858 - 17.857 MHz,
115+
- 15625 - 15.625 MHz,
116+
- 13889 - 13.889 MHz,
117+
- 12500 - 12.500 MHz,
118+
- 11364 - 11.364 MHz,
119+
- 10417 - 10.417 MHz,
120+
- 9616 - 9.615 MHz,
121+
- ....
113122

114123
The lowest selectable SPI clock frequency is 30 kHz (spiclk_rate=30) for
115124
SPI0 and SPI1. Theoretically, the SPI0 port could go slower, but there

0 commit comments

Comments
 (0)