Skip to content

Commit 5cd44d7

Browse files
authored
Merge pull request #4059 from grandixximo/docs/bullet-blanks
docs: blank line before paragraph->bullet boundaries
2 parents 648daa4 + 1260490 commit 5cd44d7

9 files changed

Lines changed: 30 additions & 0 deletions

File tree

docs/src/config/core-components.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ The __N__ (integer between 0 and 7) substitutes the spindle number.
199199
=== Pins
200200

201201
(((spindle (HAL pins))))
202+
202203
* 'spindle.__N__.at-speed' - (bit, in)
203204
Motion will pause until this pin is TRUE, under the following conditions:
204205
** before the first feed move after each spindle start or speed change;
@@ -308,6 +309,7 @@ iocontrol's HAL pins are turned on and off in non-realtime context. If you have
308309
=== Pins
309310

310311
(((iocontrol (HAL pins))))
312+
311313
* 'iocontrol.0.coolant-flood' (bit, out) TRUE when flood coolant is requested.
312314
* 'iocontrol.0.coolant-mist' (bit, out) TRUE when mist coolant is requested.
313315
* 'iocontrol.0.emc-enable-in' (bit, in) Should be driven FALSE when an external E-Stop condition exists.

docs/src/config/ini-config.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -886,6 +886,7 @@ If you want to travel along a path at 1 IPS = 60 IPM, and your servo period
886886
If you set Naive CAM tolerance to around this min length, overly short segments will be combined together to eliminate this bottleneck.
887887
Of course, setting the tolerance too high means big path deviations, so you have to play with it a bit to find a good value.
888888
I'd start at 1/2 of the min_length, then work up as needed.
889+
889890
* `ARC_BLEND_GAP_CYCLES = 4` How short the previous segment must be before the trajectory planner 'consumes' it.
890891
+
891892
Often, a circular arc blend will leave short line segments in between the blends.
@@ -894,6 +895,7 @@ Since the trajectory planner has to touch each segment at least once, it means t
894895
My fix to this way to "consume" the short segment by making it a part of the blend arc.
895896
Since the line+blend is one segment, we don't have to slow down to hit the very short segment.
896897
Likely, you won't need to touch this setting.
898+
897899
* `ARC_BLEND_RAMP_FREQ = 20` - This is a 'cutoff' frequency for using ramped velocity.
898900
+
899901
'Ramped velocity' in this case just means constant acceleration over the whole segment.

docs/src/config/stepconf.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ to those of the driver. You may find it necessary to add some time to the
8484
drive requirements to allow for this.
8585
+
8686
The LinuxCNC Configuration Selector has configs for Sherline already configured.
87+
8788
* 'Step Time' - How long the step pulse is 'on' in nano seconds. If your not
8889
sure about this setting a value of 20,000 will work with most drives.
8990
* 'Step Space' - Minimum time between step pulses in nano seconds. If your

docs/src/gcode/m-code.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
== M0, M1 Program Pause
4343

4444
(((M0, M1 Program Pause)))(((M0 Mandatory Program Pause)))(((M1 Optional Program Pause)))
45+
4546
* 'M0' - pause a running program temporarily. LinuxCNC remains in the Auto Mode
4647
so MDI and other manual actions are not enabled. Pressing the resume
4748
button will restart the program at the following line.
@@ -60,6 +61,7 @@ to stop after each line of input anyway.
6061
== M2, M30 Program End
6162

6263
(((M2 Program End)))(((M30 Pallet Exchange and Program End)))
64+
6365
* 'M2' - end the program. Pressing `Cycle Start` ("R" in the Axis GUI)
6466
will restart the program at the beginning of the file.
6567
* 'M30' - exchange pallet shuttles and end the program.
@@ -91,6 +93,7 @@ on what using % does not do.
9193
== M60 Pallet Change Pause
9294

9395
(((M60 Pallet Change Pause)))
96+
9497
* 'M60' - exchange pallet shuttles and then pause a running program
9598
temporarily (regardless of the setting of the optional stop
9699
switch). Pressing the cycle start button
@@ -100,6 +103,7 @@ on what using % does not do.
100103
== M3, M4, M5 Spindle Control
101104

102105
(((M3, M4, M5 Spindle Control)))
106+
103107
* 'M3 [$n]' - start the selected spindle clockwise at the 'S' speed.
104108
* 'M4 [$n]' - start the selected spindle counterclockwise at the 'S' speed.
105109
* 'M5 [$n]' - stop the selected spindle.
@@ -199,6 +203,7 @@ ClassicLadder.
199203
== M7, M8, M9 Coolant Control
200204

201205
(((M7, M8, M9 Coolant Control)))
206+
202207
* 'M7' - turn mist coolant on. M7 controls iocontrol.0.coolant-mist pin.
203208
* 'M8' - turn flood coolant on. M8 controls iocontrol.0.coolant-flood pin.
204209
* 'M9' - turn both M7 and M8 off.
@@ -264,6 +269,7 @@ INI Settings in the [RS274NGC] section:
264269
== M48, M49 Speed and Feed Override Control
265270

266271
(((M48, M49 Speed and Feed Override Control)))
272+
267273
* 'M48' - enable the spindle speed and feed rate override controls.
268274
* 'M49' - disable both controls.
269275

@@ -281,6 +287,7 @@ see below.
281287
== M50 Feed Override Control
282288

283289
(((M50 Feed Override Control)))
290+
284291
* 'M50 <P1>' - enable the feed rate override control. The P1
285292
is optional.
286293
* 'M50 P0' - disable the feed rate control.
@@ -293,6 +300,7 @@ and the motion will be executed at programmed feed rate.
293300
== M51 Spindle Speed Override Control
294301

295302
(((M51 Spindle Speed Override)))
303+
296304
* 'M51 <P1> <$->'- enable the spindle speed override control for the
297305
selected spindle. The P1 is optional.
298306
* 'M51 P0 <$->' - disable the spindle speed override control program.
@@ -306,6 +314,7 @@ exact program specified value of the S-word
306314
== M52 Adaptive Feed Control
307315

308316
(((M52 Adaptive Feed Control)))
317+
309318
* 'M52 <P1>' - use an adaptive feed. The P1 is optional.
310319
* 'M52 P0' - stop using adaptive feed.
311320

@@ -326,6 +335,7 @@ cutters and wire spark eroders but it is not limited to such applications.
326335
== M53 Feed Stop Control
327336

328337
(((M53 Feed Stop Control)))
338+
329339
* 'M53 <P1>' - enable the feed stop switch. The P1 is optional.
330340
Enabling the feed stop switch will allow motion to be
331341
interrupted by means of the feed stop control. In LinuxCNC,
@@ -338,6 +348,7 @@ cutters and wire spark eroders but it is not limited to such applications.
338348
== M61 Set Current Tool
339349

340350
(((M61 Set Current Tool)))
351+
341352
* 'M61 Q-' - change the current tool number while in MDI or Manual mode without
342353
a tool change. One use is when you power up LinuxCNC with a tool
343354
currently in the spindle you can set that tool number without
@@ -355,6 +366,7 @@ It is an error if:
355366
== M62 - M65 Digital Output Control
356367

357368
(((M62 - M65 Digital Output Control)))
369+
358370
* 'M62 P-' - turn on digital output synchronized with motion.
359371
* 'M63 P-' - turn off digital output synchronized with motion.
360372
* 'M64 P-' - turn on digital output immediately.

docs/src/gcode/overview.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,7 @@ can be added easily without changes to the source code.
558558
=== System Parameters
559559

560560
(((System Parameters)))
561+
561562
* '#<_spindle_rpm_mode>' - Return 1 if spindle rpm mode (G97) is on, else 0.
562563
* '#<_spindle_css_mode>' - Return 1 if constant surface speed mode (G96) is on, else 0.
563564
* '#<_ijk_absolute_mode>' - Return 1 if Absolute Arc distance mode (G90.1) is on, else 0.
@@ -1048,6 +1049,7 @@ NOTE: Inline comments on O-codes should not be used see the O-code
10481049
== Messages
10491050

10501051
(((Messages)))
1052+
10511053
* '(MSG,)' - displays message if 'MSG' appears after the left parenthesis
10521054
and before any other printing characters. Variants of 'MSG' which include
10531055
white space and lower case characters are allowed. The rest of the
@@ -1064,6 +1066,7 @@ NOTE: Inline comments on O-codes should not be used see the O-code
10641066
== Probe Logging
10651067

10661068
(((Probe Logging)))
1069+
10671070
* '(PROBEOPEN filename.txt)' - will open filename.txt and store the 9-number
10681071
coordinate consisting of XYZABCUVW of each successful straight probe in it.
10691072
* '(PROBECLOSE)' - will close the open probelog file.
@@ -1074,6 +1077,7 @@ For more information on probing see the <<gcode:g38,G38>> section.
10741077
== Logging
10751078

10761079
(((Logging)))
1080+
10771081
* '(LOGOPEN,filename.txt)' - opens the named log file. If the file already
10781082
exists, it is truncated.
10791083
* '(LOGAPPEND,filename)' - opens the named log file. If the file already
@@ -1088,20 +1092,23 @@ Examples of logging are in 'nc_files/examples/smartprobe.ngc' and in
10881092
== Abort Messages
10891093

10901094
(((Abort Messages)))
1095+
10911096
* '(ABORT,)' - displays a message like '(MSG,)' with the addition of special
10921097
handling for comment parameters as described below and of aborting the current running process.
10931098

10941099
[[gcode:debug]]
10951100
== Debug Messages
10961101

10971102
(((Debug Messages)))
1103+
10981104
* '(DEBUG,)' - displays a message like '(MSG,)' with the addition of special
10991105
handling for comment parameters as described below.
11001106

11011107
[[gcode:print]]
11021108
== Print Messages
11031109

11041110
(((Print Messages)))
1111+
11051112
* '(PRINT,)' - messages are output to 'stderr' with special handling for
11061113
comment parameters as described below.
11071114

docs/src/getting-started/about-linuxcnc.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,23 @@ are entirely licensed under the GNU General Public License and Lesser
1212
GNU General Public License (GPL and LGPL).
1313

1414
To lower the entry-hurdle, LinuxCNC provides:
15+
1516
* easy discovery and testing without installation with the Live Image,
1617
* easy installation from the Live Image,
1718
* easy to use graphical configuration wizards to rapidly create a configuration
1819
specific to the machine,
1920
* directly availability as regular packages of recent releases of Debian (since Bookworm) and Ubuntu (since Kinetic Kudu).
2021

2122
LinuxCNC provides a graphical user interface with many flavours to choose from to match your personal preferences and technical needs. Advanced users may directly exploit
23+
2224
* graphical interface creation tools (Glade, Qt),
2325
* the interpreter for 'G-code' (the RS-274 machine tool programming language),
2426
* operation of low-level machine electronics such as sensors and motor drives,
2527
* an easy to use 'breadboard' layer for quickly creating a unique configuration for your machine,
2628
* a software PLC programmable with ladder diagrams.
2729

2830
Under the hood, LinuxCNC provides
31+
2932
* a realtime motion planning system with look-ahead,
3033
* support for non-Cartesian motion systems is provided via custom
3134
kinematics modules. Available architectures include hexapods (Stewart

docs/src/gui/ngcgui.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ image::images/ngcgui.png[align="center"]
1616
== Overview
1717

1818
(((NGCGUI)))
19+
1920
* 'NGCGUI' is a Tcl application to work with subroutines. It allows you to
2021
have a conversational interface with LinuxCNC. You can organize the
2122
subroutines in the order you need them to run and concatenate the

docs/src/gui/pyvcp.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -794,6 +794,7 @@ up or down as the wheel is turned, either by dragging in a circular
794794
motion, or by rolling the mouse-wheel.
795795

796796
Optional tags:
797+
797798
* '<text>"My Text"</text>' displays text
798799
* '<bgcolor>"grey"</bgcolor> <fillcolor>"green"</fillcolor>' background & active colors
799800
* '<scale_pin>1</scale_pin>' creates scale text and a `FLOAT.scale` pin to display jog scale

docs/src/hal/rtcomps.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ On the step type and control type selected.
8282
=== Parameters
8383

8484
(((HAL stepgen parameters)))
85+
8586
* (float) `stepgen.`__<chan>__`.position-scale` - Steps per position unit. This parameter is used for both output and feedback.
8687
* (float) `stepgen.`__<chan>__`.maxvel` - Maximum velocity, in position units per second. If 0.0, has no effect.
8788
* (float) `stepgen.`__<chan>__`.maxaccel` - Maximum accel/decel rate, in positions units per second squared.

0 commit comments

Comments
 (0)